mirror of
https://github.com/zitadel/zitadel.git
synced 2024-12-04 23:45:07 +00:00
87ac5ed254
# Which Problems Are Solved The docs contained typos and links that led to 404. More subejectively the docs did not provide enough guidance for new users what providers are and how to configure an HTTP provider and then activate them. Only basic links to the API docs were given without examples on how to achieve a basic configuration. # How the Problems Are Solved References and typos fixed and reworked the guide. # Additional Changes Added code highlighting for json and bash. # Additional Context We could further improve by adding more help on this page on how to configure SMS and SMTP providers. |
||
|---|---|---|
| .. | ||
| apis/assets | ||
| docs | ||
| src | ||
| static | ||
| .gitignore | ||
| babel.config.js | ||
| buf.gen.yaml | ||
| docusaurus.config.js | ||
| frameworks.json | ||
| package.json | ||
| README.md | ||
| sidebars.js | ||
| tailwind.config.js | ||
| vercel.json | ||
| yarn.lock | ||
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