Document the LiterateCS runtime workaround - #126
Merged
Merged
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
The change is documentation-only, consistent with the repository’s existing LiterateCS configuration, and does not introduce functional or operational risk.
Pull request overview
This PR documents how to regenerate the repository’s docs/ GitHub Pages output using LiterateCS, including a runtime roll-forward workaround and a caution about avoiding automatic TOC regeneration.
Changes:
- Add a “Regenerating docs/” section to
RELEASE.md. - Document setting
DOTNET_ROLL_FORWARD=LatestMajorfor running LiterateCS targeting .NET 6 on newer runtimes. - Warn against using
-u/--updatetocto avoid overwriting the curatedTOC.yml.
File summaries
| File | Description |
|---|---|
| RELEASE.md | Adds release-process documentation for regenerating docs/ with LiterateCS, including environment/workflow caveats. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Adds a section to RELEASE.md covering docs/ regeneration: LiterateCS 2.0.46 targets .NET 6.0, so it needs
DOTNET_ROLL_FORWARD=LatestMajorto run on a machine that only has newer SDKs installed. Also notes not to pass-u/--updatetoc, which overwrites the hand-curated TOC.yml with every discovered source file.