Skip to content

Latest commit

 

History

History
97 lines (78 loc) · 3.21 KB

File metadata and controls

97 lines (78 loc) · 3.21 KB

Documentation Catalog

Purpose

docs/ is the source of truth for repository contracts. Each project must have one project index document and one or more domain contract documents.

Documentation Editing Rules

  • These rules apply to documentation authoring and editing work, not general conversational summaries.
  • Do not arbitrarily omit, delete, or simplify requested or source-backed content during documentation edits unless the user explicitly asks for that outcome.
  • If documentation content, scope, or intent is ambiguous, ask the user before deciding what to remove, merge, or reinterpret.
  • If a documentation change affects repository or domain policy boundaries, update or create the relevant AGENTS.md file in the same change when needed.

Naming Rules

  • Project index docs: docs/project-<project-id>.md
  • Domain contract docs: docs/<domain>-<project-or-component>-<contract>.md
  • Domain prefix must be one of: apps, cmds, servers, crates, protos, packages
  • Use lowercase kebab-case identifiers and stable enum-style IDs in contract sections.

Templates

  • docs/project-template.md: template for project index docs
  • docs/domain-template.md: template for domain contract docs

Project Catalog

cargo-mono

  • docs/project-cargo-mono.md
  • docs/crates-cargo-mono-foundation.md

nodeup

  • docs/project-nodeup.md
  • docs/crates-nodeup-foundation.md

with-watch

  • docs/project-with-watch.md
  • docs/crates-with-watch-foundation.md

derun

  • docs/project-derun.md
  • docs/cmds-derun-foundation.md

mpapp

  • docs/project-mpapp.md
  • docs/apps-mpapp-foundation.md

devkit

  • docs/project-devkit.md
  • docs/apps-devkit-foundation.md

devkit-remote-file-picker

  • docs/project-devkit-remote-file-picker.md
  • docs/apps-devkit-remote-file-picker-foundation.md

public-docs

  • docs/project-public-docs.md
  • docs/apps-public-docs-foundation.md

devkit-commit-tracker

  • docs/project-devkit-commit-tracker.md
  • docs/apps-devkit-commit-tracker-web-app-foundation.md

thenv

  • docs/project-thenv.md
  • docs/apps-thenv-web-console-foundation.md
  • docs/servers-thenv-server-foundation.md
  • docs/cmds-thenv-cli-foundation.md

serde-feather

  • docs/project-serde-feather.md
  • docs/crates-serde-feather-core-foundation.md
  • docs/crates-serde-feather-macros-foundation.md

rustia

  • docs/project-rustia.md
  • docs/crates-rustia-core-foundation.md
  • docs/crates-rustia-llm-foundation.md
  • docs/crates-rustia-macros-foundation.md

dexdex

  • docs/project-dexdex.md
  • docs/apps-dexdex-desktop-app-foundation.md
  • docs/apps-dexdex-ui-contract.md
  • docs/apps-dexdex-user-guide-contract.md
  • docs/apps-dexdex-notification-contract.md
  • docs/apps-dexdex-workspace-connectivity-contract.md
  • docs/servers-dexdex-main-server-foundation.md
  • docs/servers-dexdex-worker-server-foundation.md
  • docs/servers-dexdex-event-streaming-contract.md
  • docs/servers-dexdex-pr-management-contract.md
  • docs/protos-dexdex-v1-contract.md
  • docs/protos-dexdex-api-contract.md
  • docs/protos-dexdex-entities-contract.md
  • docs/protos-dexdex-plan-mode-contract.md

ttl

  • docs/project-ttl.md
  • docs/cmds-ttl-foundation.md
  • docs/cmds-ttl-language-contract.md