docs: add spec docs for environment module - #1
Merged
Merged
Conversation
Signed-off-by: Alex G. Wolff <13754094+alexgwolff@users.noreply.github.com>
Signed-off-by: Alex G. Wolff <13754094+alexgwolff@users.noreply.github.com>
Signed-off-by: Alex G. Wolff <13754094+alexgwolff@users.noreply.github.com>
alexgwolff
marked this pull request as ready for review
September 23, 2026 00:40
Remove SPECIFICATIONS.md from being ignored Signed-off-by: Alex Godoy Wolff <13754094+alexgwolff@users.noreply.github.com>
alexgwolff
changed the title
Wrap requirement statements in text blocks and list the Intent link first, matching docs/README.md and the example spec. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011uc2KL8jgKVwgzomc6Wdmp
Replace standalone SHALL/MAY/SHALL NOT labels with full EARS sentences whose subject is the software, move inline conditions into WHEN clauses, and nest Principles under the Intent section. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011uc2KL8jgKVwgzomc6Wdmp
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011uc2KL8jgKVwgzomc6Wdmp
Markdown is not rendered inside text code blocks, so the bold markers showed up as literal asterisks. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011uc2KL8jgKVwgzomc6Wdmp
Signed-off-by: Alex Godoy Wolff <13754094+alexgwolff@users.noreply.github.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011uc2KL8jgKVwgzomc6Wdmp
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011uc2KL8jgKVwgzomc6Wdmp
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
2 participants
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 the first real set of module docs (README, intent, specs, and acceptance
scenarios) for
src/environment/src/env_var, and refines the documentationconvention in
docs/README.mdbased on applying it.What does this pull request change?
src/environment/src/env_var/):README.md: module overview (sources, declarations, resolution, projection).docs/env-var-intent.md: problem, intent, principles (static declarations,security access, explicit projection), and boundaries.
projection, and host mappings.
docs/README.md,docs/example/):## Overviewsection (free-form, detailed).textblock; the Intent linkis listed first.
(
The software SHALL …,WHEN … THE SOFTWARE SHALL …).BUILDING.mdwording ("front-matter"), rootREADME.mdreflow,trailing newline in
.gitignore.How to test?
specs, and acceptance files resolve (including
#…-req-…/#…-acc-…anchors).Other Notes and Links
Doc status: Draft; verification statusis
Unknownuntil scenarios are linked to tests.Signed-off-by: Alex G. Wolff 13754094+alexgwolff@users.noreply.github.com