The documentation text is separate from the website layout. Guide files live in content/; navigation.json defines page groups and redirects. The build produces HTML, styles, scripts and the search index in dist/.
Edit a guide#
- Open the canonical file under
content/. - Update its title, description and procedure using the actual product labels.
- Keep prerequisites, meaningful inputs, results and recovery instructions together.
- Update the entry in
navigation.jsonif its location changes. Preserve a redirect when replacing an established address.
Use Markdown for paragraphs, lists, tables and code examples. The renderer also supports the steps, callouts and linked cards used by these guides. Application source, credentials and internal test records belong outside published content.
Build and check#
From this documentation site's project root, install the declared development dependencies if needed, then build:
npm install
npm run build
Review the output for missing pages, broken internal links, unsupported components and missing instructions. Check the homepage, a procedure, a reference table, search results and mobile navigation before publication.
Publish an update#
Save the source and deploy the resulting version through ChatGPT Sites to the existing site. Preserve its existing public audience and keep private evidence, credentials and customer records outside the published files. A local edit or successful build alone does not update the hosted site.
This site is a separate delivery from the original Mintlify documentation. Its pages and release notes do not automatically synchronize with the application repository or the original site's publishing workflow.