Add master engineer onboarding guide, prune stale docs - #80
Merged
Conversation
Add docs/GUIDE.md: a single, plain-English doc for new engineers covering coding principles, the full wire/type schema, and an indexed ADR summary. Remove stale exploratory content (docs/sketches/, docs/future/, docs/adaptive-context-reconciliation.md) and repoint the remaining references to it from SPEC.md, the ADRs, the context-exchange-provider profile doc, and contextgraph-trace/README.md. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01G4YxDbJgJYSCRdfXveAeeh
There was a problem hiding this comment.
Sorry @macanderson, you have reached your weekly rate limit of 250000 diff characters.
Please try again later or upgrade to continue using Sourcery
Reviewer's GuideThis docs-only PR introduces File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a single, plain-English
docs/GUIDE.mdfor engineers onboarding onto this codebase, and removes stale exploratory docs fromdocs/.What changed
docs/GUIDE.md: one master doc, in this order:handshake,query,frames,verify,error, ...), the frame shape, and every exported Rust type incontextgraph-types, described in plain terms.Written to be readable with no prior context (short sentences, concrete examples, no unexplained jargon).
docs/sketches/*(7 files, all deferred/never-implemented feature sketches),docs/future/context-receipt-impact-trace/*(out-of-scope downstream product), anddocs/adaptive-context-reconciliation.md(a resolved, point-in-time reconciliation table).SPEC.md,docs/adr/0004-dead-capability-surface.md,docs/adr/0007-protocol-product-boundary.md,docs/profiles/context-exchange-provider.md, andcontextgraph-trace/README.md— kept as prose notes ("a design sketch existed here, since removed") rather than broken links. LeftCHANGELOG.md/MIGRATION.mduntouched since those are append-only historical logs.docs/index.mdandREADME.md.Checklist
fmt,clippy -D warnings,test(docs-only change, no code touched)README.md,docs/, doc comments,--helptext)git commit -s, DCO)CHANGELOG.mdupdated under[Unreleased]if user-visible — not applicable, internal docs reorganization, no user-visible behavior changeRegistry submission (only if adding a row to
docs/registry.md)Protocol-stability impact (if a spec/wire change)
License
By submitting this pull request, I agree to dual-license this contribution under MIT OR Apache-2.0, as certified by my DCO sign-off.
Generated by Claude Code
Summary by Sourcery
Consolidate engineer onboarding documentation and remove obsolete design material without changing the protocol or code.
New Features:
Bug Fixes:
Enhancements:
Documentation: