7ee74c3354
# Which Problems Are Solved The Login mirror repo https://github.com/zitadel/typescript is outdated. With the DevX improvements done in #10571, forking the zitadel repo and developing and deploying the Login became easy. This means, the maintenance and mental overhead of syncing to the mirror repo is not justified anymore. This PR removes all references and mentions of the mirror repo, so we can archive it. # How the Problems Are Solved - Fixed the *Deploy with Vercel* button to source the Login app from the https://github.com/zitadel/zitadel repo. - Renamed *Typescript Login UI* to *Login app*. This reflects the Nx terminology in the Zitadel repo, as the Login is an Nx project in the `apps` directory. - Changed the typescript-repo route and configured a Vercel redirect from `/docs/guides/integrate/login-ui/typescript-repo` to `/docs/guides/integrate/login-ui/login-app` # Additional Changes - Removes the *Beta* status from the Login application # Additional Context - Depends on #10571 because it contains links to the updated CONTRIBUTING.md as well as the updated docs build command in Vercel.json --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
ZITADEL-Docs
This website is built using Docusaurus 2, a modern static website generator.
The documentation is part of the ZITADEL monorepo and uses pnpm and Nx for development and build processes.
Quick Start
Run the following commands from the repositorys root directory to install all dependencies needed. Using Corepack makes sure you have the pnpm version intalled that is declared in .
corepack enable
pnpm install
Start a docs server
# Start development server with live-reloading
pnpm nx run @zitadel/docs:dev
# Or serve a production build
pnpm nx run @zitadel/docs:start
The site will be available at http://localhost:3100
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.
If you are introducing new APIs (gRPC), you need to add a new entry to docusaurus.config.js under the plugins section.
Build Process
The documentation build process automatically:
- Downloads required protoc plugins - Ensures
protoc-gen-connect-openapiis available - Generates gRPC documentation - Creates API docs from proto files
- Generates API documentation - Creates OpenAPI specification docs
- Copies configuration files - Includes configuration examples
- Builds the Docusaurus site - Generates the final static site