SystemSh0cker/private-gpt
1
0
Fork 0
mirror of https://github.com/zylon-ai/private-gpt.git synced 2025-12-22 10:45:42 +01:00
Code Issues Projects Releases Packages Activity

Refactor documentation architecture (#1264)

Browse source 
* 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>
This commit is contained in:
lopagela 2023-11-19 18:46:09 +01:00 • committed by GitHub
parent 57a829a8e8
commit 36f69eed0f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
18 changed files with 399 additions and 151 deletions
Download patch file Download diff file Expand all files Collapse all files

1
fern/docs/pages/api-reference/api-reference.mdx Normal file
View file

@ -0,0 +1 @@
# API Reference

38
fern/docs/pages/api-reference/sdks.mdx Normal file
View file

@ -0,0 +1,38 @@
We use [Fern](www.buildwithfern.com) to offer API clients for Node.js, Python, Go, and Java.
We recommend using these clients to interact with our endpoints.
The clients are kept up to date automatically, so we encourage you to use the latest version.
## SDKs
*Coming soon!*
<Cards>
<Card
title="Node.js/TypeScript"
icon="fa-brands fa-node"
href="https://github.com/imartinez/privateGPT-typescript"
/>
<Card
title="Python"
icon="fa-brands fa-python"
href="https://github.com/imartinez/privateGPT-python"
/>
<br />
</Cards>
<br />
<Cards>
<Card
title="Java"
icon="fa-brands fa-java"
href="https://github.com/imartinez/privateGPT-java"
/>
<Card
title="Go"
icon="fa-brands fa-golang"
href="https://github.com/imartinez/privateGPT-go"
/>
</Cards>
<br />