diff --git a/docs/README.md b/docs/README.md index 1bd3933d6..9baac2b29 100644 --- a/docs/README.md +++ b/docs/README.md @@ -41,6 +41,12 @@ $ GIT_USER= 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 PR is created, the preview URL will be automatically commented on the PR. For staging or pre-release documentation, use the following domains [https://pre-release.jan.ai/](https://pre-release.jan.ai/) + +To officially publish documentation, create a tag in the format `vx.y.z-docs` (e.g., `v0.1.1-docs`) on the `main` branch. The documentation will then be published to [https://jan.ai/](https://jan.ai/) + ### Additional Plugins - @docusaurus/theme-live-codeblock - [Redocusaurus](https://redocusaurus.vercel.app/): manually upload swagger files at `/openapi/OpenAPISpec.json` \ No newline at end of file