docs: move internal/maintainer docs from docs/ to engdocs/
Relocate contributor- and maintainer-facing material out of docs/ so the directory can become the user-facing Mintlify site. Moves preserve subpaths (adr/, design/, staged-for-removal/ intact). messaging.md, UI_PHILOSOPHY.md, and AGENT_SIGNING.md move per their DOC_INVENTORY dispositions (design doc, design philosophy, maintainer convention). Inbound links updated repo-wide: root guides, CONTRIBUTING, AGENTS, workflows, lint config, scripts (check-doc-freshness now resolves the inventory at engdocs/DOC_INVENTORY.md), Go comments, and the synced website metadata page (regenerated via sync-website-docs.sh + generate-llms-full.sh). The emitted help text in cmd/bd/init_safety_help.go still references docs/adr/0002-init-safety-invariants.md; changing it would change bd's runtime output, which is out of scope for this branch (flagged in the PR).
This commit is contained in:
parent
672d942083
commit
0e017821f4
77 changed files with 80 additions and 79 deletions
|
|
@ -99,5 +99,5 @@ TEST_RUN=TestSomething ./scripts/test.sh
|
|||
|
||||
- The test script is in `.gitignore` path: `scripts/test.sh`
|
||||
- Skip list is in repo root: `.test-skip`
|
||||
- Full documentation: `docs/TESTING.md`
|
||||
- Full documentation: `engdocs/TESTING.md`
|
||||
- Current broken tests: See GH issues #355, #356
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ set -e
|
|||
|
||||
# Persist -tags=gms_pure_go in the go env config file (`go env -w`), so a
|
||||
# bare `go build`/`go test` run later from a shell that never sourced
|
||||
# .buildflags still picks up the tag (see docs/ICU-POLICY.md and
|
||||
# .buildflags still picks up the tag (see engdocs/ICU-POLICY.md and
|
||||
# `make doctor-build`). Read the persisted value here, before sourcing
|
||||
# .buildflags below, since that export would otherwise shadow the on-disk
|
||||
# go env value for the rest of this script.
|
||||
|
|
|
|||
2
.github/workflows/main.yml
vendored
2
.github/workflows/main.yml
vendored
|
|
@ -101,7 +101,7 @@ jobs:
|
|||
|
||||
# Fast check: every `go build|test|run|generate|install` invocation in
|
||||
# tracked scripts/hooks/CI carries -tags=gms_pure_go. Prevents ICU-linkage
|
||||
# regressions from re-entering the build (see docs/ICU-POLICY.md).
|
||||
# regressions from re-entering the build (see engdocs/ICU-POLICY.md).
|
||||
check-build-tags:
|
||||
name: Check build-tag policy
|
||||
runs-on: ubuntu-latest
|
||||
|
|
|
|||
2
.github/workflows/pr.yml
vendored
2
.github/workflows/pr.yml
vendored
|
|
@ -67,7 +67,7 @@ jobs:
|
|||
|
||||
# Fast check: every `go build|test|run|generate|install` invocation in
|
||||
# tracked scripts/hooks/CI carries -tags=gms_pure_go. Prevents ICU-linkage
|
||||
# regressions from re-entering the build (see docs/ICU-POLICY.md).
|
||||
# regressions from re-entering the build (see engdocs/ICU-POLICY.md).
|
||||
check-build-tags:
|
||||
name: Check build-tag policy
|
||||
runs-on: ubuntu-latest
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ linters:
|
|||
depguard:
|
||||
rules:
|
||||
# Mechanical enforcement of the Storage Boundary in
|
||||
# docs/PROJECT_CHARTER.md: only the storage adapter packages may
|
||||
# engdocs/PROJECT_CHARTER.md: only the storage adapter packages may
|
||||
# depend on the Dolt engine directly.
|
||||
dolt-storage-boundary:
|
||||
list-mode: lax
|
||||
|
|
@ -41,7 +41,7 @@ linters:
|
|||
- "!**/internal/metrics/metrics.go"
|
||||
deny:
|
||||
- pkg: github.com/dolthub
|
||||
desc: "Dolt engine access is restricted to the storage adapter packages (internal/storage, internal/doltserver) - see docs/PROJECT_CHARTER.md 'Storage Boundary'"
|
||||
desc: "Dolt engine access is restricted to the storage adapter packages (internal/storage, internal/doltserver) - see engdocs/PROJECT_CHARTER.md 'Storage Boundary'"
|
||||
# Companion rule for the two files excluded above: allow only
|
||||
# DoltHub's eventkit telemetry client, still deny the Dolt engine
|
||||
# (or any other dolthub package) so metrics can't become a backdoor
|
||||
|
|
@ -59,7 +59,7 @@ linters:
|
|||
- github.com/dolthub/eventkit
|
||||
deny:
|
||||
- pkg: github.com/dolthub
|
||||
desc: "Dolt engine access is restricted to the storage adapter packages (internal/storage, internal/doltserver) - see docs/PROJECT_CHARTER.md 'Storage Boundary'"
|
||||
desc: "Dolt engine access is restricted to the storage adapter packages (internal/storage, internal/doltserver) - see engdocs/PROJECT_CHARTER.md 'Storage Boundary'"
|
||||
errcheck:
|
||||
exclude-functions:
|
||||
- (*database/sql.DB).Close
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ expected and should not be flagged.
|
|||
|
||||
- **Issue Tracking** - How to use bd for work management
|
||||
- **Development Guidelines** - Code standards and testing
|
||||
- **Project Scope** - Read [docs/PROJECT_CHARTER.md](docs/PROJECT_CHARTER.md) before adding new feature surface area
|
||||
- **Project Scope** - Read [engdocs/PROJECT_CHARTER.md](engdocs/PROJECT_CHARTER.md) before adding new feature surface area
|
||||
- **Visual Design System** - Status icons, colors, and semantic styling for CLI output
|
||||
- **Contributor Protection** - Read [CONTRIBUTING.md](CONTRIBUTING.md) before handling external PRs
|
||||
- **Maintainer PR Guidelines** - Read [PR_MAINTAINER_GUIDELINES.md](PR_MAINTAINER_GUIDELINES.md) before triaging, landing, or closing PRs
|
||||
|
|
@ -22,7 +22,7 @@ expected and should not be flagged.
|
|||
## Project Scope
|
||||
|
||||
Before adding new feature surface area, read
|
||||
[docs/PROJECT_CHARTER.md](docs/PROJECT_CHARTER.md). Beads owns issue tracking
|
||||
[engdocs/PROJECT_CHARTER.md](engdocs/PROJECT_CHARTER.md). Beads owns issue tracking
|
||||
primitives and should not encode orchestration-layer policy, become a storage
|
||||
engine, or casually expand the database schema when metadata would work.
|
||||
|
||||
|
|
@ -59,7 +59,7 @@ See [AGENT_INSTRUCTIONS.md](AGENT_INSTRUCTIONS.md) for full development guidelin
|
|||
## Storage Boundary
|
||||
|
||||
The canonical storage boundary is in
|
||||
[docs/PROJECT_CHARTER.md](docs/PROJECT_CHARTER.md#storage-boundary). In short:
|
||||
[engdocs/PROJECT_CHARTER.md](engdocs/PROJECT_CHARTER.md#storage-boundary). In short:
|
||||
Beads talks to storage through a driver interface (`dolthub/driver` for Dolt).
|
||||
Do not add beads-side flocks, engine introspection, storage-specific retry or
|
||||
crash-recovery logic, or public SDK return types that leak driver internals.
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ This document contains detailed operational instructions for AI agents working o
|
|||
### Code Standards
|
||||
|
||||
- **Go version**: see `go.mod` for the required version (currently 1.26+)
|
||||
- **Linting**: `golangci-lint run ./...` (baseline warnings documented in [docs/LINTING.md](docs/LINTING.md))
|
||||
- **Linting**: `golangci-lint run ./...` (baseline warnings documented in [engdocs/LINTING.md](engdocs/LINTING.md))
|
||||
- **Testing**: All new features need tests (`make test` for the normal local/CI path, `make test-icu-path` only when intentionally exercising the opt-in ICU regex path)
|
||||
- **Documentation**: Update relevant .md files
|
||||
|
||||
|
|
@ -90,7 +90,7 @@ This enables `bd doctor` to detect **orphaned issues** - work that was committed
|
|||
|
||||
For agent-prepared commits, also include the
|
||||
`Agent-Signature:` trailer described in
|
||||
[docs/AGENT_SIGNING.md](docs/AGENT_SIGNING.md). Use `unknown-model` or
|
||||
[engdocs/AGENT_SIGNING.md](engdocs/AGENT_SIGNING.md). Use `unknown-model` or
|
||||
`unknown-reasoning` when reliable runtime metadata is unavailable.
|
||||
|
||||
### Git Workflow
|
||||
|
|
@ -133,7 +133,7 @@ value, absorb or transform it locally when practical, preserve attribution, and
|
|||
use request-changes only as a last resort.
|
||||
|
||||
Sign agent-written GitHub comments and reviews using
|
||||
[docs/AGENT_SIGNING.md](docs/AGENT_SIGNING.md).
|
||||
[engdocs/AGENT_SIGNING.md](engdocs/AGENT_SIGNING.md).
|
||||
|
||||
### External Contributor PRs: Check Before You Build
|
||||
|
||||
|
|
|
|||
|
|
@ -436,10 +436,10 @@ gate that rc.1 introduced, and ships the validated upgrade documentation.
|
|||
|
||||
### Added
|
||||
|
||||
- **`bd init --reinit-local` / `--discard-remote`** — named-intent flags for local re-initialization and explicit remote-history override. Replaces the overloaded `--force`. See [`bd help init-safety`](docs/adr/0002-init-safety-invariants.md) and [`docs/RECOVERY.md`](docs/RECOVERY.md).
|
||||
- **`bd init --reinit-local` / `--discard-remote`** — named-intent flags for local re-initialization and explicit remote-history override. Replaces the overloaded `--force`. See [`bd help init-safety`](engdocs/adr/0002-init-safety-invariants.md) and [`docs/RECOVERY.md`](docs/RECOVERY.md).
|
||||
- **`bd init-safety`** — documents the init flag surface + destroy-token format. Referenced by every init refusal message.
|
||||
- **Stable exit codes for init refusals** — `10` remote divergence, `11` local exists, `12` destroy-token missing. Grep-safe for CI.
|
||||
- **[ADR 0002 — `bd init` safety invariants](docs/adr/0002-init-safety-invariants.md)** — encodes the single-source identity rule, scope-bound `--force`/`--reinit-local`, the `CheckRemoteSafety` chokepoint, the error-text-no-echo rule, and the race-safety invariant.
|
||||
- **[ADR 0002 — `bd init` safety invariants](engdocs/adr/0002-init-safety-invariants.md)** — encodes the single-source identity rule, scope-bound `--force`/`--reinit-local`, the `CheckRemoteSafety` chokepoint, the error-text-no-echo rule, and the race-safety invariant.
|
||||
- **[`docs/RECOVERY.md`](docs/RECOVERY.md)** — playbooks for each named init refusal.
|
||||
- **CODEOWNERS** — `cmd/bd/init*.go` routes review to maintainers with an ADR-linked acknowledgment requirement.
|
||||
- **`bd -C <path>`** — run bd from another directory without changing the caller's shell cwd. Useful for hooks, agents, and scripts that coordinate multiple workspaces.
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ rules here; those details drift quickly when repeated across agent entrypoints.
|
|||
|
||||
- **Workflow and safety**: [AGENTS.md](AGENTS.md)
|
||||
- **Detailed agent operations**: [AGENT_INSTRUCTIONS.md](AGENT_INSTRUCTIONS.md)
|
||||
- **Architecture orientation**: [docs/CLAUDE.md](docs/CLAUDE.md)
|
||||
- **Architecture orientation**: [engdocs/CLAUDE.md](engdocs/CLAUDE.md)
|
||||
- **PR maintenance policy**: [PR_MAINTAINER_GUIDELINES.md](PR_MAINTAINER_GUIDELINES.md)
|
||||
|
||||
## Current Ground Rules
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ Thank you for your interest in contributing to bd! This document provides guidel
|
|||
- Git
|
||||
- A C compiler (CGO is required for the embedded Dolt database)
|
||||
- (Optional) golangci-lint for local linting
|
||||
- ICU headers are **not required** for building -- see [docs/ICU-POLICY.md](docs/ICU-POLICY.md)
|
||||
- ICU headers are **not required** for building -- see [engdocs/ICU-POLICY.md](engdocs/ICU-POLICY.md)
|
||||
|
||||
### Getting Started
|
||||
|
||||
|
|
@ -83,7 +83,7 @@ go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
|
|||
golangci-lint run ./...
|
||||
```
|
||||
|
||||
**Note**: The linter currently reports ~100 warnings. These are documented false positives and idiomatic Go patterns (deferred cleanup, Cobra interface requirements, etc.). See [docs/LINTING.md](docs/LINTING.md) for details. When contributing, focus on avoiding *new* issues rather than the baseline warnings.
|
||||
**Note**: The linter currently reports ~100 warnings. These are documented false positives and idiomatic Go patterns (deferred cleanup, Cobra interface requirements, etc.). See [engdocs/LINTING.md](engdocs/LINTING.md) for details. When contributing, focus on avoiding *new* issues rather than the baseline warnings.
|
||||
|
||||
CI will automatically run linting on all pull requests.
|
||||
|
||||
|
|
@ -92,7 +92,7 @@ CI will automatically run linting on all pull requests.
|
|||
### Project Scope
|
||||
|
||||
Before adding new feature surface area, read
|
||||
[docs/PROJECT_CHARTER.md](docs/PROJECT_CHARTER.md). Beads owns issue tracking
|
||||
[engdocs/PROJECT_CHARTER.md](engdocs/PROJECT_CHARTER.md). Beads owns issue tracking
|
||||
primitives. It should not encode orchestration-layer policy, become a storage
|
||||
engine, or expand the database schema when issue metadata is sufficient.
|
||||
|
||||
|
|
@ -139,9 +139,9 @@ If you are contributing code that involves AI decision-making or orchestration,
|
|||
|
||||
## Testing Guidelines
|
||||
|
||||
For how to run tests, see [docs/TESTING.md](docs/TESTING.md). For what to
|
||||
For how to run tests, see [engdocs/TESTING.md](engdocs/TESTING.md). For what to
|
||||
test and why (the test pyramid and tiering we follow), see
|
||||
[docs/TESTING_PHILOSOPHY.md](docs/TESTING_PHILOSOPHY.md).
|
||||
[engdocs/TESTING_PHILOSOPHY.md](engdocs/TESTING_PHILOSOPHY.md).
|
||||
|
||||
### Before Opening a PR
|
||||
|
||||
|
|
@ -152,11 +152,11 @@ test and why (the test pyramid and tiering we follow), see
|
|||
files, etc.) in test teardown.
|
||||
- If you hit a test failure unrelated to your change, don't silently skip
|
||||
it -- check `.test-skip` and file an issue if it's not already tracked
|
||||
(see [docs/TESTING.md](docs/TESTING.md#known-broken-tests)).
|
||||
(see [engdocs/TESTING.md](engdocs/TESTING.md#known-broken-tests)).
|
||||
- Ensure CI passes (`make ci-pr-core`, `make ci-pr-policy`, `make
|
||||
ci-pr-lint`) before requesting review.
|
||||
- If your change touches ICU or build tags, see
|
||||
[docs/ICU-POLICY.md](docs/ICU-POLICY.md) for the policy and rationale.
|
||||
[engdocs/ICU-POLICY.md](engdocs/ICU-POLICY.md) for the policy and rationale.
|
||||
|
||||
## Documentation
|
||||
|
||||
|
|
|
|||
2
Makefile
2
Makefile
|
|
@ -67,7 +67,7 @@ endif
|
|||
# -tags=gms_pure_go fails with a C-linker error from go-icu-regex
|
||||
# (unicode/uregex.h: No such file or directory) because go-mysql-server
|
||||
# links ICU by default under cgo; CGO_ENABLED=0 avoids that but can't open
|
||||
# embedded Dolt at runtime. See docs/ICU-POLICY.md.
|
||||
# embedded Dolt at runtime. See engdocs/ICU-POLICY.md.
|
||||
doctor-build:
|
||||
@echo "Build environment diagnostic (doctor-build):"
|
||||
@GOFLAGS_VAL="$$(go env GOFLAGS)"; \
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ For every PR, look for the value in it and choose the action that moves useful w
|
|||
|
||||
The goal is not to block contributors unnecessarily. The goal is to identify useful work, preserve it, and keep the project moving.
|
||||
|
||||
Read [docs/PROJECT_CHARTER.md](docs/PROJECT_CHARTER.md) when a PR changes
|
||||
Read [engdocs/PROJECT_CHARTER.md](engdocs/PROJECT_CHARTER.md) when a PR changes
|
||||
Beads' product surface area. Scope boundaries should guide where value lands:
|
||||
core, metadata, integration, plugin, orchestration layer, or external tool.
|
||||
|
||||
|
|
@ -99,5 +99,5 @@ These rules apply to everyone who can merge — human maintainers and agents ali
|
|||
- File follow-up work as beads issues instead of hidden notes.
|
||||
- When code changes result from PR maintenance, follow repo quality gates and session completion rules in `AGENTS.md`.
|
||||
- Post multi-line PR comments from a real Markdown body file or a shell heredoc, not from strings with escaped `\n` sequences. Run `scripts/gh-body-lint <body-file>` before posting body files; after posting or editing, verify the rendered body with `gh pr view --comments --json comments --jq ...` before moving on.
|
||||
- Sign agent-written GitHub comments, reviews, and commits using [docs/AGENT_SIGNING.md](docs/AGENT_SIGNING.md).
|
||||
- Sign agent-written GitHub comments, reviews, and commits using [engdocs/AGENT_SIGNING.md](engdocs/AGENT_SIGNING.md).
|
||||
- Before finishing, re-read the PR, latest comments, review threads, and linked issues; address or explicitly note any unresolved action items.
|
||||
|
|
|
|||
|
|
@ -85,7 +85,7 @@ Before starting a release:
|
|||
|
||||
- [ ] All tests passing (`go test ./...`)
|
||||
- [ ] npm package tests passing (`cd npm-package && npm run test:all`)
|
||||
- [ ] **Upgrade smoke tests pass** (`make test-upgrade`) — see [Release Stability Gate](docs/RELEASE-STABILITY-GATE.md)
|
||||
- [ ] **Upgrade smoke tests pass** (`make test-upgrade`) — see [Release Stability Gate](engdocs/RELEASE-STABILITY-GATE.md)
|
||||
- [ ] **Regression tests pass** (`make test-regression`)
|
||||
- [ ] **CHANGELOG.md updated with release notes** (see format below)
|
||||
- [ ] **Breaking changes documented** with migration steps and recovery instructions
|
||||
|
|
|
|||
|
|
@ -115,7 +115,7 @@ Non-interactive mode (--non-interactive or BD_NON_INTERACTIVE=1):
|
|||
// --force is a deprecated alias for --reinit-local. They share
|
||||
// semantics for the local data-safety guard; both refuse remote
|
||||
// divergence unless --discard-remote is also passed. See
|
||||
// docs/adr/0002-init-safety-invariants.md.
|
||||
// engdocs/adr/0002-init-safety-invariants.md.
|
||||
if force && !reinitLocal {
|
||||
fmt.Fprintf(os.Stderr, "%s --force is deprecated; use --reinit-local instead.\n", ui.RenderWarn("DeprecationWarning:"))
|
||||
fmt.Fprintf(os.Stderr, " See 'bd help init-safety' for the init flag surface.\n\n")
|
||||
|
|
@ -448,7 +448,7 @@ Non-interactive mode (--non-interactive or BD_NON_INTERACTIVE=1):
|
|||
// --reinit-local both bypass this local-only guard; they do NOT
|
||||
// authorize cross-boundary operations on remote history (see
|
||||
// CheckRemoteSafety at cmd/bd/init_safety.go and
|
||||
// docs/adr/0002-init-safety-invariants.md).
|
||||
// engdocs/adr/0002-init-safety-invariants.md).
|
||||
if !reinitLocal {
|
||||
if err := checkExistingBeadsData(prefix); err != nil {
|
||||
// --init-if-missing makes init idempotent, but ONLY for the
|
||||
|
|
@ -506,7 +506,7 @@ Non-interactive mode (--non-interactive or BD_NON_INTERACTIVE=1):
|
|||
} else {
|
||||
// Non-interactive (piped input, AI agent, etc.)
|
||||
//
|
||||
// ADR invariant (docs/adr/0002-init-safety-invariants.md):
|
||||
// ADR invariant (engdocs/adr/0002-init-safety-invariants.md):
|
||||
// runtime error text must not echo a complete destructive
|
||||
// invocation. See 'bd help init-safety' for the token
|
||||
// format. This closes the 58f5989bf failure class where
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ package main
|
|||
|
||||
// Init-safety decision logic.
|
||||
//
|
||||
// See docs/adr/0002-init-safety-invariants.md for the ADR this encodes.
|
||||
// See engdocs/adr/0002-init-safety-invariants.md for the ADR this encodes.
|
||||
// The invariant: every `bd init` resolves `project_id` from exactly one
|
||||
// explicitly-named source; ambiguous sources refuse. `--force` (or its
|
||||
// replacement `--reinit-local`) bypasses the local data-safety guard only;
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ import (
|
|||
// format. Its contents are the authoritative runtime reference for the
|
||||
// error-message-no-echo invariant: refusal texts point here rather than
|
||||
// constructing copy-pasteable destructive invocations. See
|
||||
// docs/adr/0002-init-safety-invariants.md.
|
||||
// engdocs/adr/0002-init-safety-invariants.md.
|
||||
var initSafetyHelpCmd = &cobra.Command{
|
||||
Use: "init-safety",
|
||||
Short: "Explain bd init flag semantics and the destroy-token format",
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ package main
|
|||
// Init-safety guard matrix + end-to-end subprocess tests.
|
||||
//
|
||||
// The table-driven tests here enforce the invariant from
|
||||
// docs/adr/0002-init-safety-invariants.md. Adding a new flag that can
|
||||
// engdocs/adr/0002-init-safety-invariants.md. Adding a new flag that can
|
||||
// interact with remote history is a signal to extend this matrix — if the
|
||||
// table doesn't exhaustively cover (dataSource × flagSet) → outcome, the
|
||||
// ADR's structural lock has a gap.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Architecture
|
||||
|
||||
This document describes bd's overall architecture - the data model, sync mechanism, and how components fit together. For product scope boundaries, see [PROJECT_CHARTER.md](PROJECT_CHARTER.md). For internal implementation details (FlushManager, Blocked Cache), see [INTERNALS.md](INTERNALS.md).
|
||||
This document describes bd's overall architecture - the data model, sync mechanism, and how components fit together. For product scope boundaries, see [PROJECT_CHARTER.md](../engdocs/PROJECT_CHARTER.md). For internal implementation details (FlushManager, Blocked Cache), see [INTERNALS.md](../engdocs/INTERNALS.md).
|
||||
|
||||
## The Two-Layer Data Model
|
||||
|
||||
|
|
@ -135,7 +135,7 @@ Branch B: bd create "Add Stripe" → bd-f14c (no collision)
|
|||
|
||||
This eliminates the need for central coordination while ensuring all machines converge to the same state.
|
||||
|
||||
See [COLLISION_MATH.md](COLLISION_MATH.md) for birthday paradox calculations on hash length vs collision probability.
|
||||
See [COLLISION_MATH.md](../engdocs/COLLISION_MATH.md) for birthday paradox calculations on hash length vs collision probability.
|
||||
|
||||
## Server Architecture
|
||||
|
||||
|
|
@ -215,7 +215,7 @@ Each issue in the Dolt database (and in JSONL exports via `bd export`) has the f
|
|||
|
||||
The schema is stable by default. Prefer issue metadata for integration,
|
||||
orchestration, or team-specific data before adding new first-class fields; see
|
||||
[Project Charter: Schema Boundary](PROJECT_CHARTER.md#schema-boundary).
|
||||
[Project Charter: Schema Boundary](../engdocs/PROJECT_CHARTER.md#schema-boundary).
|
||||
|
||||
**Core Identification:**
|
||||
|
||||
|
|
@ -359,10 +359,10 @@ The `bd mol squash` command uses hard delete intentionally - tombstones would be
|
|||
## Related Documentation
|
||||
|
||||
- [SYNC_CONCEPTS.md](SYNC_CONCEPTS.md) - How cross-machine sync works (Dolt source of truth, wire format, anti-patterns)
|
||||
- [PROJECT_CHARTER.md](PROJECT_CHARTER.md) - Product scope and boundaries
|
||||
- [PROJECT_CHARTER.md](../engdocs/PROJECT_CHARTER.md) - Product scope and boundaries
|
||||
- [MOLECULES.md](MOLECULES.md) - Molecular chemistry metaphor (protos, pour, bond, squash, burn)
|
||||
- [INTERNALS.md](INTERNALS.md) - FlushManager, Blocked Cache implementation details
|
||||
- [INTERNALS.md](../engdocs/INTERNALS.md) - FlushManager, Blocked Cache implementation details
|
||||
- [ADVANCED.md](ADVANCED.md) - Advanced features and configuration
|
||||
- [TROUBLESHOOTING.md](TROUBLESHOOTING.md) - Recovery procedures and common issues
|
||||
- [FAQ.md](FAQ.md) - Common questions about the architecture
|
||||
- [COLLISION_MATH.md](COLLISION_MATH.md) - Hash collision probability analysis
|
||||
- [COLLISION_MATH.md](../engdocs/COLLISION_MATH.md) - Hash collision probability analysis
|
||||
|
|
|
|||
|
|
@ -109,7 +109,7 @@ bd setup claude --remove
|
|||
- `cmd/bd/prime.go` - Context generation
|
||||
- `cmd/bd/setup/claude.go` - Hook installation
|
||||
- `cmd/bd/doctor/claude.go` - Integration verification
|
||||
- `docs/CLAUDE.md` - General project guidance for Claude
|
||||
- `engdocs/CLAUDE.md` - General project guidance for Claude
|
||||
|
||||
## References
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,6 @@
|
|||
The canonical Dolt backend guide is [DOLT.md](DOLT.md).
|
||||
|
||||
The previous long-form duplicate of this file has been staged at
|
||||
[staged-for-removal/DOLT-BACKEND.md](staged-for-removal/DOLT-BACKEND.md).
|
||||
[staged-for-removal/DOLT-BACKEND.md](../engdocs/staged-for-removal/DOLT-BACKEND.md).
|
||||
Rescue content from that staged copy only if it is verified against current code
|
||||
or observed CLI behaviour and belongs in the canonical guide.
|
||||
|
|
|
|||
|
|
@ -257,7 +257,7 @@ bd version
|
|||
|
||||
Building from source requires a C compiler (for CGO / embedded Dolt). **ICU is
|
||||
not required** -- all builds use the `gms_pure_go` tag which selects Go's
|
||||
stdlib `regexp` instead of ICU regex. See [ICU-POLICY.md](ICU-POLICY.md) for
|
||||
stdlib `regexp` instead of ICU regex. See [ICU-POLICY.md](../engdocs/ICU-POLICY.md) for
|
||||
details.
|
||||
|
||||
macOS (Homebrew):
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ The `metadata` field on issues accepts arbitrary JSON. Any valid JSON value is s
|
|||
Metadata is the preferred extension point for data that is specific to an
|
||||
integration, orchestrator, team workflow, or experimental automation. Before
|
||||
adding first-class fields, commands, or schema changes, check the
|
||||
[Project Charter](PROJECT_CHARTER.md#schema-boundary).
|
||||
[Project Charter](../engdocs/PROJECT_CHARTER.md#schema-boundary).
|
||||
|
||||
## Example: Agent Execution Metadata
|
||||
|
||||
|
|
@ -83,5 +83,5 @@ Avoid these prefixes in user-defined keys to prevent conflicts with future Beads
|
|||
|
||||
## Related
|
||||
|
||||
- [Project Charter](PROJECT_CHARTER.md) - Product scope and schema boundary
|
||||
- [Project Charter](../engdocs/PROJECT_CHARTER.md) - Product scope and schema boundary
|
||||
- [#1416](https://github.com/gastownhall/beads/issues/1416) - Optional schema enforcement (future)
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ error messages: each named refusal in `bd init` and `bd dolt push`/`pull`
|
|||
points here to a labeled anchor with step-by-step recovery instructions.
|
||||
|
||||
See also: `bd help init-safety`, and
|
||||
[ADR 0002 — `bd init` safety invariants](adr/0002-init-safety-invariants.md).
|
||||
[ADR 0002 — `bd init` safety invariants](../engdocs/adr/0002-init-safety-invariants.md).
|
||||
|
||||
## Table of contents
|
||||
|
||||
|
|
@ -112,7 +112,7 @@ bd init --reinit-local --discard-remote --destroy-token=DESTROY-bd
|
|||
```
|
||||
|
||||
Automation should template the token from project state, not from error
|
||||
output. See [ADR 0002 — Invariant 4](adr/0002-init-safety-invariants.md)
|
||||
output. See [ADR 0002 — Invariant 4](../engdocs/adr/0002-init-safety-invariants.md)
|
||||
for why the token is never echoed in `bd`'s error messages.
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -274,6 +274,6 @@ Build conversation chains (via orchestrator mail):
|
|||
|
||||
## See Also
|
||||
|
||||
- [Messaging](messaging.md) - Mail commands and threading
|
||||
- [Messaging](../engdocs/messaging.md) - Mail commands and threading
|
||||
- [Dependencies](QUICKSTART.md#dependencies) - Blocking dependencies
|
||||
- [CLI Reference](CLI_REFERENCE.md) - All commands
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Last reviewed: 2026-05-29
|
||||
|
||||
Freshness source: `docs/CI_TEST_SURFACE_AUDIT.md`, `.github/workflows/*.yml`,
|
||||
Freshness source: `engdocs/CI_TEST_SURFACE_AUDIT.md`, `.github/workflows/*.yml`,
|
||||
`.buildflags`, `.golangci.yml`, package test manifests, and maintainer decision
|
||||
review on 2026-05-28.
|
||||
|
||||
|
|
@ -682,7 +682,7 @@ Plan:
|
|||
2. Keep `testing.Short()` only for runtime, stress, or large-fixture skips.
|
||||
3. Move integration, e2e, API, Docker, and external dependency boundaries to
|
||||
explicit build tags, environment checks, or named wrappers.
|
||||
4. Update `docs/TESTING.md` after wrapper commands exist.
|
||||
4. Update `engdocs/TESTING.md` after wrapper commands exist.
|
||||
|
||||
Initial cleanup on branch `ci/bd-am3.1-wrapper-commands` leaves
|
||||
`testing.Short()` only in approved timeout, stress, and large-fixture tests:
|
||||
|
|
@ -69,7 +69,7 @@ exists only as an opt-in maintainer path.
|
|||
|
||||
### Go Test Runner
|
||||
|
||||
`scripts/test.sh` is the local wrapper recommended by `docs/TESTING.md`.
|
||||
`scripts/test.sh` is the local wrapper recommended by `engdocs/TESTING.md`.
|
||||
|
||||
It:
|
||||
|
||||
|
|
@ -282,9 +282,9 @@ than a repeatable CI path.
|
|||
|
||||
Examples:
|
||||
|
||||
- `docs/TESTING.md` says the wrapper script is consistent with CI, but PR CI
|
||||
- `engdocs/TESTING.md` says the wrapper script is consistent with CI, but PR CI
|
||||
uses direct `go test`.
|
||||
- `docs/LINTING.md` says CI may not fail on known lint issues, while the
|
||||
- `engdocs/LINTING.md` says CI may not fail on known lint issues, while the
|
||||
workflow uses the standard `golangci-lint` action without an explicit
|
||||
non-failing issues exit code.
|
||||
- Older staged audit docs contain obsolete test counts.
|
||||
|
|
@ -372,5 +372,5 @@ For every tier, capture enough artifacts to debug failures without rerunning:
|
|||
focused cmd/bd subset is enough.
|
||||
5. Add path-gated MCP, npm package, and website checks before touching the main
|
||||
Go matrix.
|
||||
6. Keep `docs/TESTING.md` aligned with the wrapper commands as direct workflow
|
||||
6. Keep `engdocs/TESTING.md` aligned with the wrapper commands as direct workflow
|
||||
commands are replaced.
|
||||
|
|
@ -15,13 +15,13 @@ check executes the deletion.
|
|||
| Original path | Staged path | Reason staged | Evidence gap | Rescue criteria |
|
||||
|---|---|---|---|---|
|
||||
| `docs/DOLT-BACKEND.md` | `staged-for-removal/DOLT-BACKEND.md` | Duplicates `docs/DOLT.md` and contains stale reference details. | Env/config examples include unsupported or superseded names such as `BEADS_DOLT_SERVER_PASS`; backend overview duplicated the canonical guide. | Move verified backend details into `docs/DOLT.md`; keep this path as a pointer only. |
|
||||
| `docs/README_TESTING.md` | `staged-for-removal/README_TESTING.md` | Overlaps `docs/TESTING.md` and `docs/TESTING_PHILOSOPHY.md`. | Direct `go test` workflow and fast/integration split are not the current canonical agent workflow. | Move any verified strategy details into `docs/TESTING.md` or `docs/TESTING_PHILOSOPHY.md`. |
|
||||
| `docs/RELEASING.md` | `staged-for-removal/RELEASING.md` | Duplicates root `RELEASING.md` and had diverged. | Release process is maintained at the repository root; duplicated steps drift. | Move any missing verified step into root `RELEASING.md`; keep `docs/RELEASING.md` as a pointer. |
|
||||
| `docs/README_TESTING.md` | `staged-for-removal/README_TESTING.md` | Overlaps `docs/TESTING.md` and `docs/TESTING_PHILOSOPHY.md`. | Direct `go test` workflow and fast/integration split are not the current canonical agent workflow. | Move any verified strategy details into `engdocs/TESTING.md` or `engdocs/TESTING_PHILOSOPHY.md`. |
|
||||
| `docs/RELEASING.md` | `staged-for-removal/RELEASING.md` | Duplicates root `RELEASING.md` and had diverged. | Release process is maintained at the repository root; duplicated steps drift. | Move any missing verified step into root `RELEASING.md`; keep `engdocs/RELEASING.md` as a pointer. |
|
||||
| `docs/GETTING_STARTED_ANALYSIS.md` | `staged-for-removal/GETTING_STARTED_ANALYSIS.md` | Time-stamped one-shot analysis report, not active user guidance. | Claims describe a 2026-04-05 audit state rather than current product behaviour. | Convert still-relevant findings into active docs or beads issues. |
|
||||
| `docs/audit-sync-mode-complexity.md` | `staged-for-removal/audit-sync-mode-complexity.md` | Time-stamped audit report, not active architecture or behaviour guidance. | No freshness mechanism; describes a point-in-time complexity audit. | Move verified durable architecture decisions into `docs/ARCHITECTURE.md`, `docs/DOLT.md`, or an ADR. |
|
||||
| `docs/pr-752-chaos-testing-review.md` | `staged-for-removal/pr-752-chaos-testing-review.md` | PR-specific review notes. | Tied to a historical PR, not current testing policy. | Move any still-current testing policy into `docs/TESTING.md` or `docs/TESTING_PHILOSOPHY.md`. |
|
||||
| `docs/pr-752-chaos-testing-review.md` | `staged-for-removal/pr-752-chaos-testing-review.md` | PR-specific review notes. | Tied to a historical PR, not current testing policy. | Move any still-current testing policy into `engdocs/TESTING.md` or `engdocs/TESTING_PHILOSOPHY.md`. |
|
||||
| `docs/dev-notes/ERROR_HANDLING_AUDIT.md` | `staged-for-removal/dev-notes/ERROR_HANDLING_AUDIT.md` | Historical audit note. | File/line-specific audit state is stale by default. | Move verified current patterns into `docs/ERROR_HANDLING.md`. |
|
||||
| `docs/dev-notes/MAIN_TEST_CLEANUP_PLAN.md` | `staged-for-removal/dev-notes/MAIN_TEST_CLEANUP_PLAN.md` | Resolved cleanup plan. | Tracks completed cleanup rather than active guidance. | Move durable testing policy into `docs/TESTING.md`. |
|
||||
| `docs/dev-notes/MAIN_TEST_REFACTOR_NOTES.md` | `staged-for-removal/dev-notes/MAIN_TEST_REFACTOR_NOTES.md` | Resolved refactor notes. | The file marks itself resolved and no longer owns a current seam. | Move durable lessons into `docs/TESTING_PHILOSOPHY.md`. |
|
||||
| `docs/dev-notes/MANUAL_GITHUB_GIT_REMOTE_TEST.md` | `staged-for-removal/dev-notes/MANUAL_GITHUB_GIT_REMOTE_TEST.md` | Manual test log. | Time-bounded manual procedure without a current release gate. | Move repeatable steps into `docs/TESTING.md` or an automated test issue. |
|
||||
| `docs/dev-notes/TEST_SUITE_AUDIT.md` | `staged-for-removal/dev-notes/TEST_SUITE_AUDIT.md` | Historical test-suite audit. | Snapshot of audit progress rather than current test guidance. | Move durable test principles into `docs/TESTING_PHILOSOPHY.md`. |
|
||||
| `docs/dev-notes/MAIN_TEST_CLEANUP_PLAN.md` | `staged-for-removal/dev-notes/MAIN_TEST_CLEANUP_PLAN.md` | Resolved cleanup plan. | Tracks completed cleanup rather than active guidance. | Move durable testing policy into `engdocs/TESTING.md`. |
|
||||
| `docs/dev-notes/MAIN_TEST_REFACTOR_NOTES.md` | `staged-for-removal/dev-notes/MAIN_TEST_REFACTOR_NOTES.md` | Resolved refactor notes. | The file marks itself resolved and no longer owns a current seam. | Move durable lessons into `engdocs/TESTING_PHILOSOPHY.md`. |
|
||||
| `docs/dev-notes/MANUAL_GITHUB_GIT_REMOTE_TEST.md` | `staged-for-removal/dev-notes/MANUAL_GITHUB_GIT_REMOTE_TEST.md` | Manual test log. | Time-bounded manual procedure without a current release gate. | Move repeatable steps into `engdocs/TESTING.md` or an automated test issue. |
|
||||
| `docs/dev-notes/TEST_SUITE_AUDIT.md` | `staged-for-removal/dev-notes/TEST_SUITE_AUDIT.md` | Historical test-suite audit. | Snapshot of audit progress rather than current test guidance. | Move durable test principles into `engdocs/TESTING_PHILOSOPHY.md`. |
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
// }
|
||||
// cmd := rc.GitCmd(ctx, "status") // Runs in beads repo, not CWD
|
||||
//
|
||||
// See docs/REPO_CONTEXT.md for detailed documentation.
|
||||
// See engdocs/REPO_CONTEXT.md for detailed documentation.
|
||||
package beads
|
||||
|
||||
import (
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
# (c) is an exempt third-party tool install (go install X@version).
|
||||
#
|
||||
# This is the source-time companion to scripts/verify-cgo.sh (which is a
|
||||
# runtime check on release binaries). See docs/ICU-POLICY.md.
|
||||
# runtime check on release binaries). See engdocs/ICU-POLICY.md.
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
|
|
@ -129,7 +129,7 @@ if [[ "$fail" -ne 0 ]]; then
|
|||
cat >&2 <<'EOF'
|
||||
|
||||
The beads project requires every `go build|test|run|generate|install`
|
||||
invocation to build with -tags=gms_pure_go (see docs/ICU-POLICY.md).
|
||||
invocation to build with -tags=gms_pure_go (see engdocs/ICU-POLICY.md).
|
||||
|
||||
Fix by EITHER:
|
||||
1. Source .buildflags in the script (preferred, canonical):
|
||||
|
|
|
|||
|
|
@ -23,8 +23,8 @@ DOCS=(
|
|||
"docs/JSON_SCHEMA.md|cmd/bd/output.go;cmd/bd/errors.go;cmd/bd/protocol/json_contract_test.go"
|
||||
"docs/RECOVERY.md|cmd/bd/init.go;cmd/bd/init_safety.go;cmd/bd/init_safety_test.go"
|
||||
"docs/ERROR_HANDLING.md|cmd/bd/*.go;cmd/bd/errors.go"
|
||||
"docs/LINTING.md|.golangci.yml"
|
||||
"docs/design/otel/otel-data-model.md|internal/telemetry/;internal/storage/dolt/store.go;internal/compact/haiku.go;cmd/bd/find_duplicates.go;internal/hooks/"
|
||||
"engdocs/LINTING.md|.golangci.yml"
|
||||
"engdocs/design/otel/otel-data-model.md|internal/telemetry/;internal/storage/dolt/store.go;internal/compact/haiku.go;cmd/bd/find_duplicates.go;internal/hooks/"
|
||||
)
|
||||
|
||||
echo "Checking reference doc freshness markers..."
|
||||
|
|
@ -47,6 +47,7 @@ PY
|
|||
inventory_ref_for_doc() {
|
||||
local doc="$1"
|
||||
doc="${doc#docs/}"
|
||||
doc="${doc#engdocs/}"
|
||||
printf '%s\n' "$doc"
|
||||
}
|
||||
|
||||
|
|
@ -74,11 +75,11 @@ for entry in "${DOCS[@]}"; do
|
|||
continue
|
||||
fi
|
||||
|
||||
if ! grep -Fq "\`$inventory_ref\`" "$PROJECT_ROOT/docs/DOC_INVENTORY.md"; then
|
||||
echo "FAIL: docs/DOC_INVENTORY.md does not list \`$inventory_ref\`"
|
||||
if ! grep -Fq "\`$inventory_ref\`" "$PROJECT_ROOT/engdocs/DOC_INVENTORY.md"; then
|
||||
echo "FAIL: engdocs/DOC_INVENTORY.md does not list \`$inventory_ref\`"
|
||||
ERRORS=$((ERRORS + 1))
|
||||
else
|
||||
echo "PASS: listed in docs/DOC_INVENTORY.md"
|
||||
echo "PASS: listed in engdocs/DOC_INVENTORY.md"
|
||||
fi
|
||||
|
||||
reviewed_line="$(grep -E -m1 '^Last reviewed: [0-9]{4}-[0-9]{2}-[0-9]{2}$' "$doc_path" || true)"
|
||||
|
|
|
|||
|
|
@ -61,7 +61,7 @@ Validates marker-based freshness for reference-shaped docs that are not generate
|
|||
make check-docs
|
||||
```
|
||||
|
||||
The script currently checks the reference docs named in `docs/DOC_INVENTORY.md`: `CONFIG.md`, `SETUP.md`, `ADO_CONFIG.md`, `JSON_SCHEMA.md`, `RECOVERY.md`, `ERROR_HANDLING.md`, `LINTING.md`, and `design/otel/otel-data-model.md`. Each doc must be listed in the inventory, include a recent `Last reviewed:` marker, include a `Freshness source:` marker, and name source paths or globs that exist in the repository.
|
||||
The script currently checks the reference docs named in `engdocs/DOC_INVENTORY.md`: `CONFIG.md`, `SETUP.md`, `ADO_CONFIG.md`, `JSON_SCHEMA.md`, `RECOVERY.md`, `ERROR_HANDLING.md`, `LINTING.md`, and `design/otel/otel-data-model.md`. Each doc must be listed in the inventory, include a recent `Last reviewed:` marker, include a `Freshness source:` marker, and name source paths or globs that exist in the repository.
|
||||
|
||||
Set `DOC_FRESHNESS_MAX_AGE_DAYS` to override the default 90-day review window. Set `DOC_FRESHNESS_TODAY=YYYY-MM-DD` when testing date behaviour.
|
||||
|
||||
|
|
|
|||
|
|
@ -470,7 +470,7 @@ verify_binary_has_cgo() {
|
|||
# Tries CGO_ENABLED=1 first for an embedded-capable binary. If that fails
|
||||
# (host lacks C toolchain or transitive Dolt deps' headers), falls back to
|
||||
# CGO_ENABLED=0 which yields a server-mode-only binary that still works on
|
||||
# any Go-capable box. See docs/ICU-POLICY.md and docs/INSTALLING.md.
|
||||
# any Go-capable box. See engdocs/ICU-POLICY.md and docs/INSTALLING.md.
|
||||
install_with_go() {
|
||||
log_info "Installing bd using 'go install'..."
|
||||
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ rewrite_links() {
|
|||
;;
|
||||
docs/METADATA.md)
|
||||
sed \
|
||||
-e 's#](PROJECT_CHARTER.md#](https://github.com/gastownhall/beads/blob/main/docs/PROJECT_CHARTER.md#g' \
|
||||
-e 's#](../engdocs/PROJECT_CHARTER.md#](https://github.com/gastownhall/beads/blob/main/engdocs/PROJECT_CHARTER.md#g' \
|
||||
"$source"
|
||||
;;
|
||||
*)
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ The `metadata` field on issues accepts arbitrary JSON. Any valid JSON value is s
|
|||
Metadata is the preferred extension point for data that is specific to an
|
||||
integration, orchestrator, team workflow, or experimental automation. Before
|
||||
adding first-class fields, commands, or schema changes, check the
|
||||
[Project Charter](https://github.com/gastownhall/beads/blob/main/docs/PROJECT_CHARTER.md#schema-boundary).
|
||||
[Project Charter](https://github.com/gastownhall/beads/blob/main/engdocs/PROJECT_CHARTER.md#schema-boundary).
|
||||
|
||||
## Example: Agent Execution Metadata
|
||||
|
||||
|
|
@ -89,5 +89,5 @@ Avoid these prefixes in user-defined keys to prevent conflicts with future Beads
|
|||
|
||||
## Related
|
||||
|
||||
- [Project Charter](https://github.com/gastownhall/beads/blob/main/docs/PROJECT_CHARTER.md) - Product scope and schema boundary
|
||||
- [Project Charter](https://github.com/gastownhall/beads/blob/main/engdocs/PROJECT_CHARTER.md) - Product scope and schema boundary
|
||||
- [#1416](https://github.com/gastownhall/beads/issues/1416) - Optional schema enforcement (future)
|
||||
|
|
|
|||
|
|
@ -2545,7 +2545,7 @@ The `metadata` field on issues accepts arbitrary JSON. Any valid JSON value is s
|
|||
Metadata is the preferred extension point for data that is specific to an
|
||||
integration, orchestrator, team workflow, or experimental automation. Before
|
||||
adding first-class fields, commands, or schema changes, check the
|
||||
[Project Charter](https://github.com/gastownhall/beads/blob/main/docs/PROJECT_CHARTER.md#schema-boundary).
|
||||
[Project Charter](https://github.com/gastownhall/beads/blob/main/engdocs/PROJECT_CHARTER.md#schema-boundary).
|
||||
|
||||
## Example: Agent Execution Metadata
|
||||
|
||||
|
|
@ -2623,7 +2623,7 @@ Avoid these prefixes in user-defined keys to prevent conflicts with future Beads
|
|||
|
||||
## Related
|
||||
|
||||
- [Project Charter](https://github.com/gastownhall/beads/blob/main/docs/PROJECT_CHARTER.md) - Product scope and schema boundary
|
||||
- [Project Charter](https://github.com/gastownhall/beads/blob/main/engdocs/PROJECT_CHARTER.md) - Product scope and schema boundary
|
||||
- [#1416](https://github.com/gastownhall/beads/issues/1416) - Optional schema enforcement (future)
|
||||
|
||||
</document>
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ The `metadata` field on issues accepts arbitrary JSON. Any valid JSON value is s
|
|||
Metadata is the preferred extension point for data that is specific to an
|
||||
integration, orchestrator, team workflow, or experimental automation. Before
|
||||
adding first-class fields, commands, or schema changes, check the
|
||||
[Project Charter](https://github.com/gastownhall/beads/blob/main/docs/PROJECT_CHARTER.md#schema-boundary).
|
||||
[Project Charter](https://github.com/gastownhall/beads/blob/main/engdocs/PROJECT_CHARTER.md#schema-boundary).
|
||||
|
||||
## Example: Agent Execution Metadata
|
||||
|
||||
|
|
@ -81,5 +81,5 @@ Avoid these prefixes in user-defined keys to prevent conflicts with future Beads
|
|||
|
||||
## Related
|
||||
|
||||
- [Project Charter](https://github.com/gastownhall/beads/blob/main/docs/PROJECT_CHARTER.md) - Product scope and schema boundary
|
||||
- [Project Charter](https://github.com/gastownhall/beads/blob/main/engdocs/PROJECT_CHARTER.md) - Product scope and schema boundary
|
||||
- [#1416](https://github.com/gastownhall/beads/issues/1416) - Optional schema enforcement (future)
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ The `metadata` field on issues accepts arbitrary JSON. Any valid JSON value is s
|
|||
Metadata is the preferred extension point for data that is specific to an
|
||||
integration, orchestrator, team workflow, or experimental automation. Before
|
||||
adding first-class fields, commands, or schema changes, check the
|
||||
[Project Charter](https://github.com/gastownhall/beads/blob/main/docs/PROJECT_CHARTER.md#schema-boundary).
|
||||
[Project Charter](https://github.com/gastownhall/beads/blob/main/engdocs/PROJECT_CHARTER.md#schema-boundary).
|
||||
|
||||
## Example: Agent Execution Metadata
|
||||
|
||||
|
|
@ -89,5 +89,5 @@ Avoid these prefixes in user-defined keys to prevent conflicts with future Beads
|
|||
|
||||
## Related
|
||||
|
||||
- [Project Charter](https://github.com/gastownhall/beads/blob/main/docs/PROJECT_CHARTER.md) - Product scope and schema boundary
|
||||
- [Project Charter](https://github.com/gastownhall/beads/blob/main/engdocs/PROJECT_CHARTER.md) - Product scope and schema boundary
|
||||
- [#1416](https://github.com/gastownhall/beads/issues/1416) - Optional schema enforcement (future)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue