docs: README glossary + dropdown restructure, add ROADMAP.md - #28
Merged
Conversation
- Add a "Key terms" dropdown up top defining boundary, Envelope, trace, fixture, stub, live, and cut-point, so the jargon is defined once in one place. - Move reference-heavy material (CLI, on_crossing, env vars, EnvelopeRecorder, project structure) under an "Advanced" section of collapsible dropdowns; put each recording helper and each verification layer in its own dropdown. The page now skims in a screen or two. - Cut redundancy: secrets/redaction was explained three times; keep the Security section concise and let the FAQ and glossary carry the rest. - Make stub/live explicit at the cut-point example instead of assuming the reader knows the terms. - Move the roadmap bullets out of the README into ROADMAP.md and link it. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Tisha Chawla <tisha.chawla2020@vitalum.ac.in>
chronicle/__init__.py hardcodes __version__ (the CLI reads it). If only pyproject is bumped, the CLI reports the wrong version and the release tag-guard in release.yml fails. Spell out that both must be bumped. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Tisha Chawla <tisha.chawla2020@vitalum.ac.in>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Tisha Chawla <tisha.chawla2020@vitalum.ac.in>
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
1 participant
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.
Follow-up to #27, which merged before these commits landed. Docs-only.
on_crossing, env vars,EnvelopeRecorder, project structure) moved under an Advanced section of dropdowns; each recording helper and verification layer is its own dropdown. The README now skims in a screen or two.RELEASING.md: bump__version__inchronicle/__init__.pytoo, not justpyproject.toml(the CLI reads it and the tag-guard compares it).No em/en dashes.