Skip to main content

Docs Web Information Architecture

This document maps canonical repository docs to the public Docusaurus routes for docs.mayadev.cloud.

Route Principles

  • Routes are semantic and stable; they do not expose planning-only paths.
  • .docs remains the authored source. apps/docs/.generated/docs is a build output.
  • Raw evidence, protocol captures, and Linear planning records are omitted unless explicitly reclassified.
  • Storybook is linked as an external executable component-state surface at storybook.mayadev.cloud.
  • API reference is a placeholder until a generator is implemented.

Public Route Map

SourceRouteTreatment
.docs/README.md/Generated docs index
.docs/guides/workspace-composition-10-minute-developer-happy-path.md/guides/workspace-composition-10-minute-developer-happy-pathDeveloper path
.docs/packages/assistant-composition.md/packages/assistant-compositionPackage guide
.docs/packages/assistant-ui.md/packages/assistant-uiPackage guide
.docs/packages/assistant-protocol.md/packages/assistant-protocolPackage guide
.docs/packages/claude-workspace.md/packages/claude-workspacePackage guide
.docs/packages/data-lab-module.md/packages/data-lab-modulePackage guide
generated package index/packages/Short landing page
.docs/architecture/workspace-composition.md/architecture/workspace-compositionArchitecture
.docs/architecture/workspace-composition-decisions.md/architecture/workspace-composition-decisionsComposition decisions
.docs/architecture/docs-web-decisions.md/architecture/docs-web-decisionsDocs web decisions
.docs/architecture/docs-web-source-policy.md/architecture/docs-web-source-policyDocs source policy
.docs/architecture/docs-web-api-reference-runway.md/architecture/docs-web-api-reference-runwayAPI runway
.docs/architecture/workspace-composition-v0-roadmap.md/architecture/workspace-composition-v0-roadmapPlatform roadmap
generated architecture index/architecture/Short landing page
.docs/verification.md/operations/verificationVerification
.docs/release-governance.md/operations/release-governanceRelease governance
.docs/ops/cloudflare-pages-docs.md/ops/cloudflare-pages-docsDocs deploy runbook
.docs/ops/cloudflare-pages-storybook.md/ops/cloudflare-pages-storybookStorybook deploy runbook
.docs/ops/release-deploy-runbook.md/ops/release-deploy-runbookRelease/deploy runbook
.docs/ops/secrets-and-environments.md/ops/secrets-and-environmentsSecrets policy
.docs/ops/smoke-checks.md/ops/smoke-checksPost-deploy smoke checks
generated operations index/operations/Short landing page
.docs/security/supply-chain.md/security/supply-chainSupply-chain policy
.docs/agent-native/capability-map.md/agent-native/capability-mapAgent-native map
generated component states index/reference/component-statesStorybook component-state preview entry
generated API placeholder/reference/apiPlanned future generated reference entry

Omitted Inputs

SourceReason
.docs/architecture/workspace-composition-linear-backlog.mdLinear planning source, not public product documentation
projects/claude-protocol/protocol-captures/**Raw evidence and capture notes stay out of public navigation
projects/*/dist/**/*.d.tsFuture API reference generator input
root .env* filesIgnored local secrets
.sessions/**Evidence workspace, not docs content

The Docusaurus sidebar is explicit:

  • Start: overview and developer happy path
  • Packages: package guides plus package landing page
  • Workspace Composition: architecture and contribution model
  • Docs Web: website IA, decisions, source policy, and API runway
  • Operations: verification, release, deploy, secrets, smoke checks, and supply chain
  • Reference: API placeholder, component states entry, agent-native map, and external Storybook link

Reclassification Rule

A document may move from omit to publish only when:

  • the content is safe for public navigation
  • it has a stable route
  • it does not duplicate another canonical source
  • docs-web-source-policy.md and apps/docs/scripts/prepare-content.mjs are updated in the same change