diff --git a/.gitignore b/.gitignore index 95a6c9d..dd8dee3 100644 --- a/.gitignore +++ b/.gitignore @@ -13,6 +13,7 @@ out dist coverage docs/.vitepress/dist +docs/.vitepress/cache *.tsbuildinfo playwright-report test-results diff --git a/biome.json b/biome.json index e228f80..f1d1805 100644 --- a/biome.json +++ b/biome.json @@ -10,7 +10,9 @@ "!**/coverage", "!**/playwright-report", "!**/test-results", - "!**/next-env.d.ts" + "!**/next-env.d.ts", + "!**/.vitepress/cache", + "!**/.vitepress/dist" ] }, "formatter": { diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 766f91e..cc82bb7 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -2,26 +2,34 @@ import { defineConfig } from "vitepress" export default defineConfig({ title: "CMS Docs", - description: "Engineering documentation for the CMS platform", + description: "Documentation hub for product, engineering, API, and admin/user guidance.", cleanUrls: true, lastUpdated: true, themeConfig: { nav: [ { text: "Home", link: "/" }, - { text: "Getting Started", link: "/getting-started" }, - { text: "Architecture", link: "/architecture" }, - { text: "Workflow", link: "/workflow" }, + { text: "Product / Engineering", link: "/product-engineering/" }, + { text: "Admin / User Guides", link: "/admin-user-guides/" }, + { text: "Public API", link: "/public-api/" }, ], sidebar: [ { - text: "Guide", + text: "Product / Engineering", items: [ - { text: "Overview", link: "/" }, + { text: "Section Overview", link: "/product-engineering/" }, { text: "Getting Started", link: "/getting-started" }, { text: "Architecture", link: "/architecture" }, { text: "Workflow", link: "/workflow" }, ], }, + { + text: "Admin / User Guides", + items: [{ text: "Section Overview", link: "/admin-user-guides/" }], + }, + { + text: "Public API", + items: [{ text: "Section Overview", link: "/public-api/" }], + }, ], socialLinks: [{ icon: "github", link: "https://example.com/replace-with-repo" }], footer: { diff --git a/docs/admin-user-guides/index.md b/docs/admin-user-guides/index.md new file mode 100644 index 0000000..1de1476 --- /dev/null +++ b/docs/admin-user-guides/index.md @@ -0,0 +1,23 @@ +# Admin / User Guides + +This section will hold practical guides for non-engineering and operational usage of the admin app. + +## Intended Audience + +- Admins +- Editors +- Managers +- Internal operators + +## Planned Guide Topics + +- Navigating dashboard sections +- Role and permission behavior by task +- Managing pages and navigation +- Managing media and artwork refinement +- Handling commissions and kanban flow +- Publishing and preview workflows + +## Status + +This section is intentionally scaffolded early and will be filled as core features land. diff --git a/docs/index.md b/docs/index.md index af481dc..7a54842 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,6 +2,12 @@ Engineering documentation hub for this repository. +## Documentation Tracks + +- [Product / Engineering](/product-engineering/) +- [Admin / User Guides](/admin-user-guides/) +- [Public API](/public-api/) + ## Core Sources - Roadmap and progress: `TODO.md` diff --git a/docs/product-engineering/index.md b/docs/product-engineering/index.md new file mode 100644 index 0000000..e8034d0 --- /dev/null +++ b/docs/product-engineering/index.md @@ -0,0 +1,22 @@ +# Product / Engineering Docs + +This section covers platform and implementation documentation for engineers and product stakeholders. + +## Start Here + +- [Getting Started](/getting-started) +- [Architecture](/architecture) +- [Workflow](/workflow) + +## Scope + +- System architecture and boundaries +- RBAC and CRUD base standards +- Delivery workflow and promotion flow +- Infrastructure and deployment runbooks + +## Planned Expansions + +- Domain model and glossary +- ADR (Architecture Decision Record) index +- Operational playbooks (incident, rollback, recovery) diff --git a/docs/public-api/index.md b/docs/public-api/index.md new file mode 100644 index 0000000..e9d5336 --- /dev/null +++ b/docs/public-api/index.md @@ -0,0 +1,17 @@ +# Public API Docs + +This section is reserved for externally consumable API documentation. + +## Current Status + +No stable public API surface is documented yet. + +## Planned Approach + +- Add API docs when real endpoints are implemented and versioned +- Use OpenAPI as source of truth for endpoint reference +- Keep integration guides and authentication examples here + +## Notes + +Internal endpoints should not be treated as public API until explicitly documented in this section.