36f69eed0f
* Refactor documentation architecture Split into several `tab` and sections * Fix Fern's docs.yml after PR review Thank you Danny! Co-authored-by: dannysheridan <danny@buildwithfern.com> * Re-add quickstart in the overview tab It went missing after a refactoring of the doc architecture * Documentation writing * Adapt Makefile to fern documentation * Do not create overlapping page names in fern documentation This is causing 500. Thank you to @dsinghvi for the troubleshooting and the help! * Add a readme to help to understand how fern documentation work and how to add new pages * Rework the welcome view Redirects directly users to installation guide with links for people that are not familiar with documentation browsing. * Simplify the quickstart guide * PR feedback on installation guide A ton of refactoring can still be made there * PR feedback on ingestion * PR feedback on ingestion splitting * Rename section on LLM * Fix missing word in list of LLMs --------- Co-authored-by: dannysheridan <danny@buildwithfern.com>
1.4 KiB
Documentation of privateGPT
The documentation of this project is being rendered thanks to fern.
Fern is basically transforming your .md and .mdx files into a static website: your documentation.
The configuration of your documentation is done in the ./docs.yml file.
There, you can configure the navbar, tabs, sections and pages being rendered.
The documentation of fern (and the syntax of its configuration docs.yml) is
available there docs.buildwithfern.com.
How to run fern
You cannot render your documentation locally without fern credentials.
To see how your documentation looks like, you have to use the CICD of this repository (by opening a PR, CICD job will be executed, and a preview of your PR's documentation will be deployed in vercel automatically, through fern).
The only thing you can do locally, is to run fern check, which check the syntax of
your docs.yml file.
How to add a new page
Add in the docs.yml a new page, with the following syntax:
navigation:
# ...
- tab: my-existing-tab
layout:
# ...
- section: My Existing Section
contents:
# ...
- page: My new page display name
# The path of the page, relative to `fern/`
path: ./docs/pages/my-existing-tab/new-page-content.mdx