Look at mintlify and/or inkeep for docs

[linear]

https://mintlify.com

https://inkeep.com/

[linear]

HIG-4683 Look at mintlify and/or inkeep for docs

[greptile-apps]

To integrate Mintlify or Inkeep for documentation, follow these steps:

1. Identify Documentation Files: Documentation files are located in the docs-content directory. Examples include:

   • /docs-content/getting-started/3_client-sdk/2_remix.md
   • /docs-content/getting-started/5_backend-logging/06_hosting/fly-io.md
   • /docs-content/getting-started/5_backend-logging/02_js/nodejs.md

2. Update Documentation Format: Ensure that the documentation format is compatible with Mintlify or Inkeep. This may involve updating frontmatter or content structure.

3. Integrate Mintlify/Inkeep: Follow the specific integration steps provided by Mintlify or Inkeep to include their functionality in your documentation pipeline.

4. Modify QuickStart Components: If necessary, update the QuickStart components to render content as required by Mintlify or Inkeep. Examples of QuickStart components can be found in the following files:

   • /docs-content/getting-started/3_client-sdk/5_gatsbyjs.md
   • /docs-content/getting-started/5_backend-logging/02_js/nestjs.md
   • /docs-content/getting-started/4_backend-sdk/js/nestjs.md
   • /docs-content/getting-started/4_backend-sdk/js/express.md

Refer to the Mintlify or Inkeep documentation for detailed integration steps.

References

/docs-content/getting-started/3_client-sdk/2_remix.md
/docs-content/getting-started/5_backend-logging/06_hosting/fly-io.md
/docs-content/getting-started/5_backend-logging/02_js/nodejs.md
/docs-content/getting-started/3_client-sdk/5_gatsbyjs.md
/docs-content/getting-started/3_client-sdk/7_replay-configuration/index.md
/docs-content/getting-started/5_backend-logging/02_js/nestjs.md
/docs-content/getting-started/4_backend-sdk/js/nestjs.md
/docs-content/getting-started/4_backend-sdk/js/express.md

Ask Greptile