Docs Workflow
Use this workflow when adding or updating documentation.
Source of Truth
Section titled “Source of Truth”English docs are the source of truth until another locale is intentionally added. Write pages in src/content/docs/.
Page Template
Section titled “Page Template”Use this structure for walkthroughs:
- Goal
- Before you start
- Steps
- Verify it worked
- Troubleshooting
- Related guides
AI Authoring Rules
Section titled “AI Authoring Rules”- Inspect the product behavior before writing procedural docs.
- Keep docs customer-facing and avoid implementation details.
- Do not import from the WebinarStack application repo.
- Do not reference secrets, private IDs, or internal-only runbooks.
- Prefer screenshots or short videos when a workflow has important visual state.
Review Checklist
Section titled “Review Checklist”- The guide matches the current product UI.
- Links resolve.
- Images have useful alt text.
- Videos have descriptive titles.
- The page builds with
pnpm build.