f8f19af8c5
* docs: add DeepSeek R1 local installation guide - Add comprehensive guide for running DeepSeek R1 locally - Include step-by-step instructions with screenshots - Add VRAM requirements and model selection guide - Include system prompt setup instructions * docs: add comprehensive guide on running AI models locally * docs: address PR feedback for DeepSeek R1 and local AI guides - Improve language and terminology throughout - Add Linux support information - Enhance technical explanations - Update introduction for better flow - Fix parameters section in run-ai-models-locally.mdx * docs: improve local AI guides content and linking - Update titles and introductions for better SEO - Add opinionated guidance section for beginners - Link DeepSeek guide with general local AI guide - Fix typos and improve readability * docs: add new changelog posts and images - Add DeepSeek R1 changelog (v0.5.14) - Add key issues resolved changelog (v0.5.13) - Add corresponding changelog images --------- Co-authored-by: Louis <louis@jan.ai>
Website & Docs
This website is built using Nextra, a modern static website generator.
Information Architecture
We try to keep routes consistent to maintain SEO.
-
/guides/: Guides on how to use the Jan application. For end users who are directly using Jan. -
/developer/: Developer docs on how to extend Jan. These pages are about what people can build with our software. -
/api-reference/: Reference documentation for the Jan API server, written in Swagger/OpenAPI format. -
/changelog/: A list of changes made to the Jan application with each release. -
/blog/: A blog for the Jan application.
How to Contribute
Refer to the Contributing Guide for more comprehensive information on how to contribute to the Jan project.
Pre-requisites and Installation
Installation
cd jan/docs
yarn install
yarn dev
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Build
yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
Using SSH:
USE_SSH=true yarn deploy
Not using SSH:
GIT_USER=<Your GitHub username> yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.
Preview URL, Pre-release and Publishing Documentation
-
When a pull request is created, the preview URL will be automatically commented on the pull request.
-
The documentation will then be published to https://jan.ai/ when the pull request is merged to
main.