Skip to content

Commit 5b569c5

Browse files
committed
Remove legacy ai_docs directory
1 parent 47872f4 commit 5b569c5

13 files changed

Lines changed: 17 additions & 17 deletions

AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,6 @@ This project is a static toolbox site. The landing page (`index.html`) lists sma
3131
- A new regression spec enforces Home buttons across apps—after tweaking navigation chrome, run `npx playwright test tests/home-navigation.spec.js`.
3232

3333
## Documentation
34-
- The `ai_docs/` directory hosts the Markdown knowledge base. Update the relevant guides whenever you change workflows, scripts, or datasets so the docs remain authoritative.
35-
- When you add, remove, or rename a guide, update the `guides` array in `ai_docs/index.html` so the navigation stays in sync.
36-
- After editing documentation, open `ai_docs/index.html` in a browser (or via `npx serve .`) to confirm the Markdown renders through Marked and the hash navigation works.
34+
- The `docs/` directory hosts the Markdown knowledge base. Update the relevant guides whenever you change workflows, scripts, or datasets so the docs remain authoritative.
35+
- When you add, remove, or rename a guide, update the `guides` array in `docs/index.html` so the navigation stays in sync.
36+
- After editing documentation, open `docs/index.html` in a browser (or via `npx serve .`) to confirm the Markdown renders through Marked and the hash navigation works.

ai_docs/AGENTS.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/AGENTS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Documentation workspace
2+
3+
- Keep documentation in Markdown under `docs/docs/`. Use descriptive headings and prefer tables for directory overviews.
4+
- Whenever you add a new guide, update `docs/index.html` so the navigation lists the page. Each entry in the `guides` array should include an `id`, `title`, `file`, and concise `summary`.
5+
- Render tweaks should preserve the two-space indentation used throughout the HTML and CSS. Stick with the existing palette and typography to keep the docs visually aligned with the landing page.
6+
- After editing docs, load `docs/index.html` in a browser (or via `npx serve .`) to confirm the Markdown renders and navigation links update the hash correctly.
7+
- Keep cross-references current: when workflows, scripts, or tests change, update the relevant Markdown sections and summaries so the knowledge base stays authoritative.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
## Log excerpt
44

55
```
6-
2025-09-25T02:26:41Z warn Service worker returned /index.html for navigation request /ai_docs/
6+
2025-09-25T02:26:41Z warn Service worker returned /index.html for navigation request /docs/
77
2025-09-25T02:26:42Z info Retrying navigation without cache fallback
88
2025-09-25T02:26:42Z info Navigation succeeded after bypassing cached landing page
99
```
1010

1111
## What went wrong
1212

1313
The service worker treated every navigation as eligible for the cached landing page before attempting a network fetch. When the
14-
homepage already lived in the cache, the `ai_docs/` navigation surfaced the landing markup instead of the documentation shell.
14+
homepage already lived in the cache, the `docs/` navigation surfaced the landing markup instead of the documentation shell.
1515

1616
## Mitigation
1717

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This guide distils the practices captured across the repository’s `AGENTS.md`
1818
## Adding or updating apps
1919

2020
1. Create a folder under `apps/<name>/` with `index.html`, any supporting datasets, and a script entry point (`app.js`).
21-
2. Follow the landing page card pattern (`<a class="app-button">`) and add the new card to `index.html`. Include developer shortcut links in the `.dev-tools` section when relevant.
21+
2. Follow the landing page card pattern (`<a class="app-button">`) and add the new card to `index.html`. Include developer shortcut links in the `.dev-tools` section when relevant. Pick an emoji or icon that is unique across the landing page so no two apps share the same symbol.
2222
3. If the app ships multiple pages (archives, compact views), ensure each page exposes a Home link (`../../`) so `tests/home-navigation.spec.js` and `tests/home.spec.js` stay green.
2323
4. Update `offline-manifest.json` via `npm run build:offline` so the service worker caches the new assets.
2424
5. Add or extend Playwright specs under `tests/` to cover the new surface area.
@@ -36,5 +36,5 @@ This guide distils the practices captured across the repository’s `AGENTS.md`
3636

3737
## Documentation upkeep
3838

39-
- The `ai_docs/` folder hosts this documentation hub. Whenever you add a new guide, update `ai_docs/index.html` to register it in the navigation.
39+
- The `docs/` folder hosts this documentation hub. Whenever you add a new guide, update `docs/index.html` to register it in the navigation.
4040
- Keep the docs in sync with behavioural changes (new scripts, updated datasets, revised tests). Treat documentation updates as part of each pull request that changes workflows.
File renamed without changes.

0 commit comments

Comments
 (0)