Skip to content

docs: update spec section references for v0.4 - #12

Merged
OriginDevIT merged 1 commit into
mainfrom
docs/claude-md-references
Aug 30, 2026
Merged

docs: update spec section references for v0.4#12
OriginDevIT merged 1 commit into
mainfrom
docs/claude-md-references

Conversation

@OriginDevIT

Copy link
Copy Markdown
Owner

Closes #6

What

v0.4 of docs/spec/events-and-adapters.md inserted §3.3 (the event catalogue) and shifted the old §3 "Core entities" — and everything below it — down by one. The "no data-source connectors" reasoning moved from §3.1.1 → §4.1.1.

File Location Was Now
CLAUDE.md invariant 4 §3.1.1 §4.1.1
CONTRIBUTING.md "No data-source connectors" §3.1.1 §4.1.1
README.md "What it deliberately does not do" §3.1.1 §4.1.1

Verification

  • Read v0.4 §4.1.1 ("On data sources — a deliberate non-feature") and confirmed it is the section all three lines describe — not renumbered mechanically. v0.4 §3 is now "Events" (3.1 Ordering, 3.2 Namespaces, 3.3 Catalogue, 3.4 Deferred); there is no §3.1.1.
  • These are the only numbered spec references in the three files. Other docs/spec/ mentions are generic and need no change.
  • Confirmed packages/adapter-kit/src/index.ts still matches spec §8, including Adapter.handle(event: OsdsAnyEvent, …) (spec PR docs(spec): Adapter.handle takes OsdsAnyEvent #11). No mismatch, no change needed.

Out of scope / needs a maintainer decision

docs/agent-operations.md:114 carries the same stale docs/spec/ §3.1.1 in the data-source-connector decline boilerplate. That file is on the "requires a human" list in CLAUDE.md, and #6 scoped this to CLAUDE.md / CONTRIBUTING.md (+ README). Left untouched here — say the word and I'll fix it in this PR or a follow-up.

🤖 Generated with Claude Code

v0.4 inserted §3.3 (event catalogue) and shifted the old §3 "Core
entities" and everything below it down by one. The "no data-source
connectors" reasoning moved from §3.1.1 to §4.1.1.

- CLAUDE.md invariant 4: §3.1.1 -> §4.1.1
- CONTRIBUTING.md "No data-source connectors": §3.1.1 -> §4.1.1
- README.md "What it deliberately does not do": §3.1.1 -> §4.1.1

Each corrected reference was verified by reading the section it now
points at. These are the only numbered spec references in the three
files.

Separately confirmed packages/adapter-kit/src/index.ts still matches
spec §8, including Adapter.handle(event: OsdsAnyEvent, ...); no change
needed there.

Closes #6

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Puf9jhj137U3iswf4GWZkG
Signed-off-by: Matthew Wren <info@origindev.com>
@OriginDevIT
OriginDevIT merged commit 2b86b84 into main Aug 30, 2026
1 check passed
@OriginDevIT
OriginDevIT deleted the docs/claude-md-references branch August 30, 2026 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: update CLAUDE.md section references for spec v0.4

1 participant