Product Functionality Documentation
Product Functionality Documentation
Section titled “Product Functionality Documentation”This directory contains per-feature documentation for the Canonical platform. Each functional area has its own subdirectory with user journeys, workflows, and technical details.
Folder Structure
Section titled “Folder Structure”| Directory | Covers | Key Routes/Components |
|---|---|---|
search/ | Semantic + keyword search, filters, saved searches | /api/search/, SearchPage, browse filters |
content-management/ | Browse, create, edit, lifecycle, layers, source documents | /api/items/, BrowsePage, ItemDetailPage |
bid-management/ | Completing forms (procurement first): pipeline, Q&A library, responses, templates | /api/procurement/, /procurement/[id], /library |
quality-governance/ | Quality scores, freshness, review queue, governance | /api/governance/, ReviewPage, quality cron |
knowledge-organisation/ | Taxonomy, layers, guides, coverage, entities, tags | /api/taxonomy/, CoveragePage, GuidePage |
ai-integration/ | MCP server, classification, summaries, embeddings | /api/mcp/, lib/ai/, MCP tools |
administration/ | Settings, roles, entity management, notifications, cron | /api/settings/, SettingsPage, user roles |
Templates
Section titled “Templates”Three templates in _templates/ provide consistent structure:
| Template | Use For |
|---|---|
user-journeys.template.md | Documenting end-to-end user workflows by role |
workflows.template.md | Documenting system workflows (data flow, state machines, automation) |
technical.template.md | Documenting API routes, components, hooks, and database details |
Documentation Status
Section titled “Documentation Status”| Area | Status | Last Updated |
|---|---|---|
| search | Done | 29 April 2026 |
| content-management | Done | 29 April 2026 |
| bid-management | Done | 29 April 2026 |
| quality-governance | Done | 29 April 2026 |
| knowledge-organisation | Done | 29 April 2026 |
| ai-integration | Done | 29 April 2026 |
| administration | Done | 29 April 2026 |
Guidance for Authoring Agents
Section titled “Guidance for Authoring Agents”When writing or updating documentation in this directory:
-
Always read the actual codebase. Do not rely on other documentation files for current state — they may be stale. Read the routes, components, hooks, and tests directly.
-
Use the templates. Start from the appropriate template in
_templates/. Each template has instructions at the top explaining what to include. -
Cross-reference with generated stats. Check
docs/generated/for current counts (tools, routes, components, etc.) rather than hardcoding numbers. -
Query the database if needed. Use Supabase MCP tools (
execute_sql,list_tables) to verify schema details, RLS policies, and RPC functions. -
Note limitations honestly. Every feature has rough edges — document them. This helps future development sessions prioritise work.
-
UK English throughout. DD/MM/YYYY dates, “colour” not “color”, “organisation” not “organization”.
-
Keep files focused. One file per document type per functional area. If a file grows beyond ~500 lines, split it.
-
Update the status table in this README when you add or update documentation for a functional area.
Related Reference Documents
Section titled “Related Reference Documents”| Document | Location | Purpose |
|---|---|---|
| State of the Product | docs/reference/state-of-the-product.md | High-level product reference |
| Schema Quick Reference | docs/reference/SCHEMA-QUICK-REFERENCE.md | All 30 tables, columns, functions |
| Codebase Stats | docs/generated/codebase-stats.md | Auto-generated volatile counts |
| MCP Inventory | docs/generated/mcp-inventory.md | Auto-generated tool/resource/prompt list |
| AI Integration Layers | docs/reference/ai-integration-layers.md | 5-layer AI architecture |
| Classification Prompt | docs/reference/classification-prompt.md | Domain taxonomy and classification rules |
| Design System | docs/design/warm-meridian-implementation-spec.md | Semantic tokens, components |