You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This repository contains the Docusaurus documentation for the KoliBri component library.
4
+
5
+
## Development setup
6
+
7
+
- Use **pnpm** as the package manager. Run `pnpm install` if dependencies are missing.
8
+
- Check TypeScript and ESLint rules with `pnpm run lint`.
9
+
- Ensure the site can be built locally with `pnpm run build`.
10
+
11
+
## Commit messages
12
+
13
+
Commits must follow the [Conventional Commits](https://www.conventionalcommits.org) style. A commitlint configuration is present in `commitlint.config.js`.
14
+
15
+
## Documentation and translation rules
16
+
17
+
Follow these rules when editing or adding docs:
18
+
19
+
- File names must be in **English** to generate SEO-friendly URLs.
20
+
- Keep translations close to the original text.
21
+
- Translation keys are written in English using **kebab-case**.
22
+
- The default translation text (`message`) is written in **German**.
23
+
- Use the `translate` method rather than the `Translate` component.
24
+
- Do not add custom translation descriptions.
25
+
- Avoid explicit `slug` definitions (except in `docs/welcome.md`); slugs are generated from file names.
26
+
- All code samples and technical terms are in English.
27
+
- Remove tag sections: replace `/tags:(\n.+)+/` with `---`.
28
+
29
+
## Formatting conventions
30
+
31
+
- Tabs are used for indentation except in Markdown files (see `.editorconfig`).
32
+
- Prettier is configured for a line width of 120 characters and single quotes.
33
+
34
+
## Required checks before committing
35
+
36
+
Run the following commands and ensure they succeed:
0 commit comments