mirror of
https://github.com/zitadel/zitadel.git
synced 2025-02-28 20:57:24 +00:00
4df3b6492c
# Which Problems Are Solved There were no guideline to how design future APIs and their endpoints. The V3 documentation was to specific and targeted towards internal stakeholders. This PR is intended as base and kept to the minimum. If more details or additional guideline or rules are needed, they will be added in the future. # How the Problems Are Solved - Removed the V3 description and corresponding examples. - Provided general guideline for the design of APIs, which includes the structure, naming, versioning, error handling and more. # Additional Changes None # Additional Context closes #9184 --------- Co-authored-by: Maximilian <mpa@zitadel.com> Co-authored-by: Silvan <27845747+adlerhurst@users.noreply.github.com>
ZITADEL-Docs
This website is built using Docusaurus 2, a modern static website generator.
Add new Sites to existing Topics
To add a new site to the already existing structure simply save the md file into the corresponding folder and append the sites id int the file sidebars.js.
Installation
Install dependencies with
yarn install
then run
yarn generate
Local Development
Start a local development server with
yarn start
When working on the API docs, run a local development server with
yarn start:api
Container Image
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
docker build -f docs/Dockerfile . -t zitadel-docs
docker run -p 8080:8080 zitadel-docs