Whop Wiki Contributing Guidelines

This file helps automated tools (like Bugbot) understand how to contribute to the wiki.

Contribution Patterns

Adding a New Page

  1. Create an .mdx file in the appropriate section folder

  2. Add frontmatter with title, description, and icon:

    ---
    title: Page Title
    description: Brief description
    icon: icon-name
    ---
  3. Add the page path to docs.json under the correct navigation group

  4. Update the changelog if it's a significant addition

Editing Existing Pages

  1. Make your changes to the .mdx file

  2. Preserve existing frontmatter

  3. Follow the style guide (see Wiki Standards)

Changelog Entries

For user-facing or significant changes, add an entry to changelog/overview.mdx:

File Organization

Mintlify Components

Common components you can use:

  • <Card> - Linked cards with icons

  • <CardGroup> - Grid of cards

  • <Tabs> / <Tab> - Tabbed content

  • <Accordion> - Collapsible sections

  • <Info>, <Warning>, <Note> - Callouts

  • <Update> - Changelog entries

  • <Steps> - Numbered steps

CI Checks

  • Changelog Reminder: PRs that modify docs without updating the changelog will receive a reminder comment

  • Mintlify Build: Validates that docs build successfully

Questions?

See the Wiki Standardsarrow-up-right page or ask in #engineering.

Last updated

Was this helpful?