docs: design-document v1.8, dev-docs restructure, VitePress user docs scaffold, backlog update
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
37
CLAUDE.md
37
CLAUDE.md
@@ -4,7 +4,7 @@
|
||||
|
||||
Crewli is a multi-tenant SaaS platform for event and festival management.
|
||||
Built for a professional volunteer organisation, with potential to expand as SaaS.
|
||||
Design document: `/resources/design/design-document.md`
|
||||
Design document: `/dev-docs/design-document.md`
|
||||
|
||||
## Tech stack
|
||||
|
||||
@@ -130,3 +130,38 @@ Configure three frontend origins in both Laravel (`config/cors.php` via env) and
|
||||
11. Pinia store if cross-component state is needed
|
||||
12. Vue page component
|
||||
13. Add route in Vue Router
|
||||
|
||||
## User Documentation (VitePress)
|
||||
|
||||
End-user documentation lives in /docs/ as a VitePress site.
|
||||
Developer documentation (SCHEMA.md, API.md, etc.) lives in /dev-docs/.
|
||||
|
||||
### When to write docs
|
||||
|
||||
When completing a feature that introduces or changes **user-facing behaviour**,
|
||||
create or update the corresponding documentation page under /docs/.
|
||||
|
||||
### How to write docs
|
||||
|
||||
1. Read /docs/.templates/style-guide.md for terminology, tone, and structure rules
|
||||
2. Use /docs/.templates/feature-page.md or concept-page.md as your starting template
|
||||
3. Every page MUST have frontmatter with: title, description, tags
|
||||
4. Use Dutch language for all content (informal "je/jij")
|
||||
5. Use Crewli terminology from the style guide — never English equivalents in user docs
|
||||
|
||||
### What to include
|
||||
|
||||
- What the feature does (2-3 sentences)
|
||||
- Step-by-step instructions from the user's perspective
|
||||
- Which roles have access (table format)
|
||||
- Screenshot placeholders where visual guidance helps: ``
|
||||
- Links to related pages
|
||||
|
||||
### File placement
|
||||
|
||||
Match the existing structure under /docs/:
|
||||
|
||||
- Organizer features → /docs/organizer/[category]/
|
||||
- Volunteer features → /docs/volunteer/
|
||||
- Portal features → /docs/portal/
|
||||
- General concepts → /docs/guide/
|
||||
|
||||
Reference in New Issue
Block a user