mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-05 22:02:15 +00:00
docs: fixed some typos, formatting, grammar (#11540)
# Which Problems Are Solved - Typos - Punctuation - Markdown table formatting - ... (A bunch of issues my editor gave) # How the Problems Are Solved # Additional Changes # Additional Context
This commit is contained in:
+12
-12
@@ -20,24 +20,24 @@ The site will be available at http://localhost:3000.
|
||||
|
||||
Key scripts for documentation workflows:
|
||||
|
||||
| Script | Description |
|
||||
| :--- | :--- |
|
||||
| `dev` | Starts the development server. |
|
||||
| `build` | Builds the production application. |
|
||||
| `fetch:remote-content` | Fetches remote tags and referenced content. |
|
||||
| `generate` | Runs all generation steps (`fetch:remote-content`, `generate:proto-docs`, `generate:api-reference`, `generate:index-pages`). |
|
||||
| `check:links` | Validates content integrity (broken links, missing frontmatter, schema errors). |
|
||||
| `check-types` | Validates typescript types. |
|
||||
| `test` | Runs all validation steps (`check-types`, `check:links`). |
|
||||
| `lint` | checks for code style and syntax errors (ESLint). |
|
||||
| `clean` | Cleans the build output and generated files. |
|
||||
| Script | Description |
|
||||
|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------|
|
||||
| `dev` | Starts the development server. |
|
||||
| `build` | Builds the production application. |
|
||||
| `fetch:remote-content` | Fetches remote tags and referenced content. |
|
||||
| `generate` | Runs all generation steps (`fetch:remote-content`, `generate:proto-docs`, `generate:api-reference`, `generate:index-pages`). |
|
||||
| `check:links` | Validates content integrity (broken links, missing frontmatter, schema errors). |
|
||||
| `check-types` | Validates typescript types. |
|
||||
| `test` | Runs all validation steps (`check-types`, `check:links`). |
|
||||
| `lint` | checks for code style and syntax errors (ESLint). |
|
||||
| `clean` | Cleans the build output and generated files. |
|
||||
|
||||
### Validation
|
||||
|
||||
* **Code Quality**: Run `pnpm lint` to check for syntax and style issues in JS/TS/MDX files.
|
||||
* **Content Integrity**: Run `pnpm check:links` to validate content structure, including:
|
||||
* Broken internal links
|
||||
* Missing required frontmatter (e.g., `title`)
|
||||
* Missing required front-matter (e.g., `title`)
|
||||
* Image references
|
||||
|
||||
## Contributing
|
||||
|
||||
Reference in New Issue
Block a user