Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions docs/docs/docs-maintenance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Documentation maintenance

The documentation hub lives under `docs/` and renders Markdown guides inside `docs/index.html`. Use this checklist to keep the
knowledge base accurate whenever workflows or datasets evolve.

## Editing guides

- Place Markdown files inside `docs/docs/` so the loader can fetch them via relative paths.
- Use descriptive headings and keep tables aligned with two-space indentation to match the rest of the docs.
- Reference paths exactly as they appear in the repository (for example ``apps/jokes/jokes.js``) so quick searches stay useful.
- When documenting commands, wrap them in fenced code blocks tagged with the shell language (`````bash```) for consistent
styling.

## Updating navigation

- Register each new guide in the `guides` array inside `docs/index.html`. Supply an `id`, human-readable `title`, Markdown `file`
path, and a short `summary`.
- Keep the `id` stable and URL-friendly—hash navigation uses it to update the address bar and history state.
- Order entries intentionally: place high-level introductions (`overview`, `architecture`) near the top and workflows or
reference material further down.

## Previewing changes

1. From the repository root, install dependencies if you have not already:
```bash
npm install
```
2. Serve the docs with any static server. `npx serve .` exposes the site at `http://localhost:3000/` by default, while
`python -m http.server` works in Python-heavy environments.
3. Open `http://localhost:3000/docs/` (or the equivalent port) and cycle through every guide to confirm the navigation, progress
indicator, and hash routing behave as expected.

## Keeping content fresh

- Mirror updates to Playwright specs, maintenance scripts, and dataset workflows in the relevant guides so the docs remain the
source of truth.
- Whenever you touch the offline manifest or service worker, cross-link the change in both the **Data maintenance** and
**Testing & automation** guides to reinforce the workflow.
- When you remove or rename a guide, delete the corresponding Markdown file and prune the `guides` array to avoid 404s.

## Pull request expectations

- Documentation updates ship alongside code changes that alter workflows. Avoid leaving TODO comments—describe the intended
process directly in the Markdown.
- Before opening a pull request, skim the rendered diff (for example with `git diff --word-diff`) to catch spelling errors and
missing commands.
1 change: 1 addition & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,7 @@ <h2 data-doc-title>Loading…</h2>
{ id: 'deploy-logs', title: 'Deploy logs', file: 'docs/deploy-logs.md', summary: 'Service worker navigation + Pages deploy log' },
{ id: 'data-maintenance', title: 'Data maintenance', file: 'docs/data-maintenance.md', summary: 'Datasets, manifests, and embeddings' },
{ id: 'testing-automation', title: 'Testing & automation', file: 'docs/testing-and-automation.md', summary: 'Playwright suite and CI workflows' },
{ id: 'docs-maintenance', title: 'Documentation maintenance', file: 'docs/docs-maintenance.md', summary: 'Keep the knowledge base accurate and linked' },
{ id: 'development-guide', title: 'Development guide', file: 'docs/development-guide.md', summary: 'Coding conventions and contributor tasks' }
];

Expand Down
Loading