Skip to content

Commit bb86f08

Browse files
V48 (specification-implementation): Add FAMILIARIZATION.md codebase walkthrough
Introduce a full package-and-uapi familiarization guide covering product model, spec-driven development, the generics inheritance hierarchy (execution/agent/ tool/pipeline/LLM/prompt), package catalog, experience layers, runtime hosts, and task-based reading paths. Wire from README, AGENTS, SOURCE_LAYOUT, and V48 NOTES.
1 parent 28a57a5 commit bb86f08

5 files changed

Lines changed: 561 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
- Never explicitly version source code without direct instruction. Source code is always implicitly versioned to the active Bitcode canon and current gate; routes, file names, CSS files, constants, classes, API paths, tests, and implementation identifiers must be written in-place as the single current Bitcode system. Do not introduce names such as `api/v1`, `v27-*`, `first-gate-*`, `wip-*`, or similar version/gate/work-in-progress source constructs unless explicitly directed for a bounded compatibility artifact.
55
- Do not consider any legacy code. All legacy code is located under `_legacy/`.
66
- **Source layout and modularity (required):** follow `internal-docs/BITCODE_SOURCE_LAYOUT.md` and `uapi/components/README.md`. Dependency direction is `packages` → Bitcode/Shadcn adapters → experience components → thin `uapi/app` page shells. Seven experiences (Marketing, Packs, Reads, Deposits, Docs, Conversations, Auxillaries) plus `Shadcn*` / `Bitcode*` bases. New components live in **named directories** (`ComponentName/ComponentName.tsx` — not `index.tsx`) with co-located `hooks/`, `styles/`, `__tests__/`. Prefer packages for pure domain logic. Product run language is **Pipeline**; BTD ledger language is **journal**. **Do not reintroduce Terminal** (`app/terminal` is deleted; no `/terminal` product route).
7+
- **Codebase familiarization:** read `FAMILIARIZATION.md` for the package catalog, uapi request path, and the inheritance pattern `*-generics` primitives → `generic-*` base implementations → product specializations (agents, tools, pipelines, prompts, LLMs).
78
- Highest caliber software engineering crafstmanship (maintainibility, abstractions, architectures, naming, patterns, comments, documentation, structures, algorithmic and data flow designs, UI/UX, etc.), correctness (specification and implementation precision, reliability, completeness, boundaried, scoped, encapsulated, etc.), and auditable (totalistic proofs systems from static code, build time, runtime, etc. etc. as is Bitcode, tests from unit, integration, E2E, linting and building, etc.). Every non-trivial file carries a top-of-file overview comment; obey SRP and DRY; co-locate unit tests with components when practical.
89
- Do not push work directly to `main`. Create a version base branch for each draft target, such as `version/v28`, then create scoped gate branches from that version branch. Gate branches must be prefixed with the gate number, such as `v28/gate-3-read-fit-workflow` or `v28/gate-8-promotion-proof`. Pull-request each closed gate back into the version branch. Pull-request the version branch into `main` only when all gates are closed and the version is formally promoted as canon. The default branch is protected by the `Bitcode Core Contributions` ruleset and requires pull requests plus verified signatures.
910
- Gate pull request titles must begin with the uppercase version and gate prefix, followed by a concise topical title, for example `V29 Gate 5: AssetPack Disclosure Rights And Preview Depth`. Version-promotion pull requests must begin with the uppercase version and name canonical promotion.

BITCODE_SPEC_V48_NOTES.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1451,3 +1451,11 @@ Canonical filesystem and co-location rules live in
14511451

14521452
Public package export paths preserved. Jest deposit/depository/synthesis suites green.
14531453

1454+
1455+
1456+
## FAMILIARIZATION.md (codebase walkthrough)
1457+
1458+
`FAMILIARIZATION.md` is the in-repo deep map of packages, uapi, and inheritance
1459+
hierarchies (`*-generics``generic-*` → product specializations). It is a
1460+
teaching/navigation document, not stronger than `BITCODE_SPEC_V48.md`. Update it
1461+
when package families or experience entry paths change.

0 commit comments

Comments
 (0)