BranchPy
Log in

Docs-Builder

# Technical Documentation Map

Scope: Authoritative technical references for BranchPy (v1.1.1). User-facing workflows live in ../User-Guide/.

What Lives Here

  • Feature-owned folders (e.g., auth, backend, server, api, errors, logging, events).
  • Canonical docs: README.md (overview), plus architecture/configuration/observability/errors/troubleshooting as needed.
  • Framework indices (e.g., api/api.md) that point to domain docs; they do not host domain narratives.

Naming & Structure

  • Folder and file names: lowercase, hyphenated if needed (e.g., auth-licensing-sso).
  • Versioned root: docs/1.1.1/Technical/ (source docs/v1.1.0/ is read-only).
  • One feature per folder; avoid mixed-domain dumping grounds.
  • Link to the owning domain’s canonical doc; avoid duplicating content.
  • API conventions stay in api/; domain-specific endpoints belong to their domain folders.
  • Use relative links; prefer indexes/tables for navigation when possible.

Migration Metadata

  • _migration/ (sibling to Technical) holds merge-maps, subset reports, deferred extracts, and rehome plans.
  • Deferred content is temporary; every extract must have a planned destination and owner.

Contributions Checklist

  • Confirm ownership: add/change docs only within the correct domain folder.
  • Keep scope narrow: if content feels cross-domain, add pointers instead of copying.
  • Update indexes (e.g., Technical/api/api.md) when new canonical docs appear.
  • Record moves/extracts in _migration/ to preserve traceability.