docs: improve api docs (#5158)

* integrate docs into nav * generator for local use, production needs to be set by env * fix typo * local dev * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: annotate the first user endpoints in the management api * docs: add header params * rewrite docs links and improve ci * tweak build command * fix path * Update docs/docusaurus.config.js Co-authored-by: Max Peintner <max@caos.ch> * fix docker * docs: add header params * docs: Add tags to management api. add some descriptions * docs: more descriptions * docs: more descriptions * docs: required fields * docs: example request * docs: example request * docs: example request * docs: example request * docs: example request * docs: user metadata requests * docs: user requests * docs: user requests * docs: user requests * docs: user requests * docs: change nav add first methods to authentication api * docs: auth api * docs: auth api * docs: auth api * docs: auth api * docs: auth api * docs: api sidenav * chore: use buf without docker * fix deploy * fix ci * fix vercel * docs: admin * docs: admin api docs * docs: admin api docs * docs: admin api docs * docs: admin api docs * docs: security * docs: security * docs: admin api * docs: change to env vars * docs: auth api * docs: remove assets, deprecated requests, menu * reworked page with PaloAltoNetworks/docusaurus-openapi-docs * works with the resolutions * fix broken build by adding assets again * add tags to menu * chore: improve build speed * no-minify * test ssr * ssr 20 * use lazy * increase mem * use default mem * change names * docs: remove assets, deprecated requests, menu * docs: management api * docs: management api * docs: management api * docs: sidebar * not the best word smithing but it is ;-) * more typos * merge main * fix some error * trial * update grpc gateway * trigger vercel build * docs: deprecated requests * docs: deprecated requests --------- Co-authored-by: Fabienne <fabienne.gerschwiler@gmail.com> Co-authored-by: Max Peintner <max@caos.ch>
2025-08-11 18:07:31 +00:00 · 2023-02-23 12:08:06 +01:00
parent 50728129ee
commit aa9518ac02
68 changed files with 7570 additions and 23543 deletions
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,6 +1,4 @@
-[![Netlify Status](https://api.netlify.com/api/v1/badges/b82a23f7-d8c7-4025-af18-a46586e89ed0/deploy-status)](https://app.netlify.com/sites/zitadel-docs/deploys)
-
-# Website
+# ZITADEL-Docs

 This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.

@@ -10,34 +8,25 @@ To add a new site to the already existing structure simply save the `md` file in

 ## Installation

-```console
+```
 yarn install
 ```

 ## Local Development

-```console
+```
 yarn start
 ```

-As an alternative you can use this docker compose command:
+## Container Image

-```console
-docker compose up
+If you just want to start docusaurus locally without installing node you can fallback to our container image.
+Execute the following commands from the repository root to build and start a local version of ZITADEL 
+
+```shell
+docker build -f docs/Dockerfile . -t zitadel-docs
 ```

-These commands start a local development server.
-Most changes are reflected live without having to restart the server.
-
-## Build
-
-```console
-yarn build
-```
-
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
-
-## Deployment
-
-Each PR will be automatically built with a preview link from cloudflare pages.
-Visit the checks / comments on the PR for the link.
+```shell
+docker run -p 8080:8080 zitadel-docs
+```