Repository navigation
Add the student layout rule for Validation pages to AGENTS.md - #24
Merged
Merged
Conversation
The shared core block now asks for Validation and Explanation pages that a new student can read, with a fixed layout per case, and links to the full description in the PROTEUS contributing guide.
There was a problem hiding this comment.
🟢 Approval recommended
The documentation changes match the stated scope, the checksum was verified, and no unresolved issues remain.
No open issues 🎉
What changed in this PR
This documentation-only PR adds a student-focused layout rule for Validation pages and new Explanation sections in SPIDER’s shared contributor guidance.
Changes:
- Defines the Validation page structure, including explanatory lead-ins, plot guidance, and collapsed Test details boxes.
- Links to the shared writing guide and updates the
fwl-corechecksum.
| File | Description |
|---|---|
AGENTS.md |
Adds student-focused documentation guidance and updates the shared-block checksum. |
Review effort: Balanced
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
AGENTS.mdnow carries the shared rule for the Validation pages and new Explanation sections: write them for a student who knows physics but not this code, in the layout of Writing Validation and Explanation pages. It replaces the older sentence on a per-case subsection: the reference, tolerance, test id and command of each case now sit in its Test details box.Changes
AGENTS.md: the student-docs rule in the sharedfwl-coreblock.Validation
fwl-coreandfwl-voiceblocks are identical to those in the PROTEUSAGENTS.mdon main.writing-validation-and-explanation-pagesandhow-do-i-contribute.687a0b26c9d369ac55880e2f10e8801ed81a56cc: https://github.com/FormingWorlds/SPIDER/actions/runs/40467285965 (success).