huge documentaton restructure for docusaurus
This commit is contained in:
@@ -11,17 +11,24 @@ This folder defines the bilingual help center that serves both guest app users a
|
||||
## Directory Layout
|
||||
```
|
||||
docs/help/
|
||||
├── README.md # This blueprint
|
||||
├── templates/ # Authoring templates per locale
|
||||
├── guest/ # Guest-focused articles (paired locales)
|
||||
│ ├── index.en.md
|
||||
│ └── index.de.md
|
||||
└── admin/ # Customer admin articles (paired locales)
|
||||
├── index.en.md
|
||||
└── index.de.md
|
||||
├── README.md
|
||||
├── en/
|
||||
│ ├── admin/
|
||||
│ │ ├── index.md
|
||||
│ │ └── …
|
||||
│ ├── guest/
|
||||
│ │ ├── index.md
|
||||
│ │ └── …
|
||||
│ └── templates/
|
||||
│ └── article.md
|
||||
└── de/
|
||||
├── admin/
|
||||
├── guest/
|
||||
└── templates/
|
||||
```
|
||||
- Articles live in the audience folder and follow the naming pattern `<slug>.<locale>.md` (e.g., `offline-sync.en.md`).
|
||||
- Each article includes YAML front matter to describe metadata used by the app and Filament resource.
|
||||
- English and German live under their respective locale folders, which keeps slugs unique for the Docusaurus build (`/help/en/admin/...`, `/help/de/guest/...`).
|
||||
- Inside each locale folder, article filenames match their slug (e.g., `post-event-wrapup.md`). Paired locales keep the same slug and metadata.
|
||||
- Every article includes the YAML front matter shown below so the apps and Filament know how to render status, owners, etc.
|
||||
|
||||
## Front Matter Contract
|
||||
```yaml
|
||||
@@ -72,7 +79,7 @@ related:
|
||||
- **Standalone Web**: optional `/help` public site generated from the same Markdown using Vite/React and server-side rendering for SEO.
|
||||
|
||||
## Governance & Backlog
|
||||
- Track work in `docs/todo/help.md` (create if needed) and link issues to article slugs.
|
||||
- Track work in `docs/process/todo/help.md` (create if needed) and link issues to article slugs.
|
||||
- Add CI checks:
|
||||
- Ensure every `.en.md` file has a matching `.de.md` file with equal `slug`/`version_introduced`.
|
||||
- Validate required front matter keys.
|
||||
|
||||
Reference in New Issue
Block a user