Skip to content

docs: add ai-docs/ reference directory for AI agents#166

Draft
Copilot wants to merge 1 commit into
mainfrom
copilot/create-md-documentation
Draft

docs: add ai-docs/ reference directory for AI agents#166
Copilot wants to merge 1 commit into
mainfrom
copilot/create-md-documentation

Conversation

Copilot AI commented Apr 11, 2026

Copy link
Copy Markdown
Contributor

No structured AI-agent-focused documentation existed; only the top-level AGENTS.md and the human-facing docs/ knowledge base.

Added ai-docs/ — 7 markdown files

  • README.md — index table + five-step quick-start for agents
  • project-overview.md — repo layout table, full app inventory, key architectural constraints
  • architecture.md — landing page wiring, service worker lifecycle, offline manifest schema, data-loading patterns per app type, asset pipeline diagram
  • apps-catalog.md — all 12 apps: purpose, key files, window.* globals, data dependencies, Playwright spec mapping
  • data-and-tools.md — every file in data/, every script in tools/ with flags/examples, full sequential refresh workflow
  • testing.md — all 18 specs with responsibilities, per-change runbook (what to run after each class of edit), CI workflow summary
  • development-conventions.md — HTML/CSS/JS rules (IIFE, no var, guard clauses, DocumentFragment for tables), accessibility patterns, step-by-step new-app checklist, common mistakes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants