Eric Allam
b01880e669
This commit introduces a new documentation file, CLAUDE.md, outlining the standards and practices using Mintlify for our documentation. The update was needed to provide comprehensive guidelines for creating and maintaining consistent, high-quality documentation that supports user success while aligning with our project context. - Implement a framework for collaborative documentation efforts, encouraging constructive feedback and evidence-based reasoning. - Emphasize the importance of accuracy, usability, and making content evergreen. - Highlight writing standards such as using second-person voice, testing code examples, and maintaining consistent style and formatting. - Include a strict Git workflow, advocating for frequent commits and adherence to pre-commit hooks. The new CLAUDE.md file serves as a foundation for future documentation efforts, ensuring clarity and effectiveness in how we convey information to users.
Development
Install and initial setup
pnpm install
Running the app
pnpm run dev --filter docs
View the app locally
It runs locally here:
http://localhost:3050