This repository contains the documentation for Endgame, built using the Mintlify platform. The documentation is deployed as a "monorepo" on Mintlify, meaning all Mintlify-specific files are contained within the /mintlify subdirectory rather than the project root.
mintlify-docs/
├── mintlify/ # Main documentation directory (deployed)
│ ├── mint.json # Mintlify configuration
│ ├── index.mdx # Homepage
│ ├── changelog.mdx # Auto-generated changelog page
│ ├── *.mdx # Documentation pages
│ ├── changelog_entries/ # Individual changelog entries (format: YYYY_MM_DD_prXXXX.change.md)
│ ├── features/ # Feature documentation
│ ├── integrations/ # Integration guides
│ ├── trust/ # Security & privacy docs
│ ├── images/ # Image assets
│ ├── logo/ # Logo assets
│ └── snippets/ # Reusable content blocks
├── internal/ # Gitignored directory (not deployed)
│ ├── notion_site/ # One-time snapshot of old Notion docs
│ └── changelog/ # Auto-generated changelog data
│ ├── input/ # Raw changelog from GitHub/Linear
│ └── claude/ # Processed changelog entries
├── src/ # Python tools for changelog generation
│ └── generate_changelog.py # Script that processes changelog entries
├── README.md # This file
├── CLAUDE.md # AI assistant instructions
├── Makefile # Build automation
├── Procfile # Process definitions
└── pyproject.toml # Python project configuration
- Node.js version 19 or higher
- Mintlify CLI installed globally
Install the Mintlify CLI to preview documentation changes locally:
```npm i -g mint
### Local Development
Navigate to the `/mintlify` directory and start the development server:
```bash
cd mintlify
mint devView your local preview at http://localhost:3000.
To use a custom port:
mint dev --port 3333Check for broken links in your documentation:
mint broken-linksThis command scans all documentation files for internal and external links, reporting any that are broken or unreachable.
Keep the Mintlify CLI up to date:
mint updateThis project is deployed as a Mintlify "monorepo", which means:
- All Mintlify documentation files are contained in the
/mintlifysubdirectory - The
mint.jsonconfiguration file is located at/mintlify/mint.json - When running commands like
mint dev, you must be in the/mintlifydirectory - The deployment process knows to look in this subdirectory for the documentation
/mintlify/mint.json: Central configuration file defining site structure, navigation, theming, and metadata/mintlify/*.mdx: Documentation content written in MDX (Markdown + JSX components)/internal/: This directory is gitignored and not meant for deployment. Contains:- Historical documentation snapshots
- Auto-generated changelog data from GitHub and Linear
The project includes an automated changelog generation system that processes individual changelog entries into a formatted changelog page.
Individual changelog entries are stored in /mintlify/changelog_entries/ with the naming convention:
YYYY_MM_DD_prXXXX.change.md
Each entry file contains:
- A title heading (# Title)
- Bullet points describing the changes
- Links section with references to:
- GitHub PR (e.g., https://github.com/Endgame-Labs/cerebro/pull/XXXX)
- Linear issues (e.g., https://linear.app/endgame/issue/END-XXXX)
Example entry:
# New User Management Page
- Manage user invitations.
- View and manage organization users.
- Assign user roles.
Links:
https://github.com/Endgame-Labs/cerebro/pull/5194
https://linear.app/endgame/issue/END-4107To process all individual changelog entries and update the main changelog page:
make changesThis command:
- Activates the Python virtual environment
- Runs the
src/generate_changelog.pyscript - Processes all
.change.mdfiles in/mintlify/changelog_entries/ - Groups entries by date
- Updates the
/mintlify/changelog.mdxfile with the formatted changelog
The generated changelog uses Mintlify's <Update> components with date labels, organizing changes chronologically with the most recent updates first.
Changes are automatically deployed to production when pushed to the main branch via the Mintlify GitHub app integration. No manual build or deployment commands are needed.
- Dev environment won't start: Run
mint updateto ensure you have the latest CLI version - 404 errors: Make sure you're running commands from the
/mintlifydirectory wheremint.jsonis located - Broken links: Use
mint broken-linksto identify and fix broken internal/external links