This page tracks the work needed to move documentation from the app and README into Mintlify.Documentation Index
Fetch the complete documentation index at: https://docs.vinum-elabel.com/llms.txt
Use this file to discover all available pages before exploring further.
Completed in this branch
- Created a Mintlify
docs.jsonin the repositorydocs/directory. - Migrated first-pass content from README and in-app documentation pages into MDX.
- Added navigation groups for getting started, workflows, compliance, and reference.
- Added compliance disclaimers around legal review and package-side requirements.
- Added a monorepo setup note in
docs/README.md.
Before publishing
- Configure Mintlify monorepo deployment path as
/docs. - Install the Mintlify CLI with Node.js 20.17.0 or newer.
- Run
mint devfrom thedocs/directory and check every page. - Run
mint broken-linksfrom thedocs/directory. - Confirm the production documentation domain and footer links.
- Decide whether in-app pages should redirect to Mintlify or keep a short embedded help experience.
- Review every compliance page with a qualified advisor before publishing externally.
- Add screenshots or product images after the UI copy stabilizes.
- Add redirects if existing public documentation URLs need to remain valid.
Content still to migrate
- FAQ content beyond the first product guidance pass.
- Billing and pricing documentation once plan names and limits are finalized.
- Account security and email management flows.
- Supabase deployment and edge function runbooks.
- Admin, support, and incident response runbooks if they should be public.
- API documentation only after public API endpoints are confirmed.
Suggested launch sequence
- Preview and validate the MDX locally.
- Open a pull request for docs review.
- Complete legal and compliance review.
- Configure Mintlify with
/docsas the monorepo documentation path. - Publish to the temporary
.mintlify.appURL. - Connect the final custom domain.
- Update product navigation and support links.