diff --git a/AGENTS.md b/AGENTS.md index df1902b..0904204 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -31,6 +31,6 @@ This project is a static toolbox site. The landing page (`index.html`) lists sma - A new regression spec enforces Home buttons across apps—after tweaking navigation chrome, run `npx playwright test tests/home-navigation.spec.js`. ## Documentation -- 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. -- When you add, remove, or rename a guide, update the `guides` array in `ai_docs/index.html` so the navigation stays in sync. -- 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. +- The `docs/` directory hosts the Markdown knowledge base. Update the relevant guides whenever you change workflows, scripts, or datasets so the docs remain authoritative. +- When you add, remove, or rename a guide, update the `guides` array in `docs/index.html` so the navigation stays in sync. +- 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. diff --git a/ai_docs/AGENTS.md b/ai_docs/AGENTS.md deleted file mode 100644 index a22bb6b..0000000 --- a/ai_docs/AGENTS.md +++ /dev/null @@ -1,7 +0,0 @@ -# AI documentation workspace - -- Keep documentation in Markdown under `ai_docs/docs/`. Use descriptive headings and prefer tables for directory overviews. -- Whenever you add a new guide, update `ai_docs/index.html` so the navigation lists the page. Each entry in the `guides` array should include an `id`, `title`, `file`, and concise `summary`. -- 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. -- After editing docs, load `ai_docs/index.html` in a browser (or via `npx serve .`) to confirm the Markdown renders and navigation links update the hash correctly. -- Keep cross-references current: when workflows, scripts, or tests change, update the relevant Markdown sections and summaries so the knowledge base stays authoritative. diff --git a/docs/AGENTS.md b/docs/AGENTS.md new file mode 100644 index 0000000..18e9953 --- /dev/null +++ b/docs/AGENTS.md @@ -0,0 +1,7 @@ +# Documentation workspace + +- Keep documentation in Markdown under `docs/docs/`. Use descriptive headings and prefer tables for directory overviews. +- 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`. +- 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. +- 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. +- Keep cross-references current: when workflows, scripts, or tests change, update the relevant Markdown sections and summaries so the knowledge base stays authoritative. diff --git a/ai_docs/docs/apps.md b/docs/docs/apps.md similarity index 100% rename from ai_docs/docs/apps.md rename to docs/docs/apps.md diff --git a/ai_docs/docs/architecture.md b/docs/docs/architecture.md similarity index 100% rename from ai_docs/docs/architecture.md rename to docs/docs/architecture.md diff --git a/ai_docs/docs/data-maintenance.md b/docs/docs/data-maintenance.md similarity index 100% rename from ai_docs/docs/data-maintenance.md rename to docs/docs/data-maintenance.md diff --git a/ai_docs/docs/deploy-logs.md b/docs/docs/deploy-logs.md similarity index 94% rename from ai_docs/docs/deploy-logs.md rename to docs/docs/deploy-logs.md index 847fdd7..89011b5 100644 --- a/ai_docs/docs/deploy-logs.md +++ b/docs/docs/deploy-logs.md @@ -3,7 +3,7 @@ ## Log excerpt ``` -2025-09-25T02:26:41Z warn Service worker returned /index.html for navigation request /ai_docs/ +2025-09-25T02:26:41Z warn Service worker returned /index.html for navigation request /docs/ 2025-09-25T02:26:42Z info Retrying navigation without cache fallback 2025-09-25T02:26:42Z info Navigation succeeded after bypassing cached landing page ``` @@ -11,7 +11,7 @@ ## What went wrong The service worker treated every navigation as eligible for the cached landing page before attempting a network fetch. When the -homepage already lived in the cache, the `ai_docs/` navigation surfaced the landing markup instead of the documentation shell. +homepage already lived in the cache, the `docs/` navigation surfaced the landing markup instead of the documentation shell. ## Mitigation diff --git a/ai_docs/docs/development-guide.md b/docs/docs/development-guide.md similarity index 92% rename from ai_docs/docs/development-guide.md rename to docs/docs/development-guide.md index 8b313a9..6bc00e1 100644 --- a/ai_docs/docs/development-guide.md +++ b/docs/docs/development-guide.md @@ -18,7 +18,7 @@ This guide distils the practices captured across the repository’s `AGENTS.md` ## Adding or updating apps 1. Create a folder under `apps//` with `index.html`, any supporting datasets, and a script entry point (`app.js`). -2. Follow the landing page card pattern (``) and add the new card to `index.html`. Include developer shortcut links in the `.dev-tools` section when relevant. +2. Follow the landing page card pattern (``) 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. 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. 4. Update `offline-manifest.json` via `npm run build:offline` so the service worker caches the new assets. 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` ## Documentation upkeep -- 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. +- The `docs/` folder hosts this documentation hub. Whenever you add a new guide, update `docs/index.html` to register it in the navigation. - 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. diff --git a/ai_docs/docs/overview.md b/docs/docs/overview.md similarity index 100% rename from ai_docs/docs/overview.md rename to docs/docs/overview.md diff --git a/ai_docs/docs/testing-and-automation.md b/docs/docs/testing-and-automation.md similarity index 100% rename from ai_docs/docs/testing-and-automation.md rename to docs/docs/testing-and-automation.md diff --git a/ai_docs/docs/wiki-authoring.md b/docs/docs/wiki-authoring.md similarity index 100% rename from ai_docs/docs/wiki-authoring.md rename to docs/docs/wiki-authoring.md diff --git a/ai_docs/index.html b/docs/index.html similarity index 100% rename from ai_docs/index.html rename to docs/index.html diff --git a/index.html b/index.html index 198f936..74110b1 100644 --- a/index.html +++ b/index.html @@ -503,9 +503,9 @@

Labs & tools
  • - - - AI Docs + + + Docs