Fix broken and fragile links in CHANGES.md#28977
Open
arifthpe wants to merge 3 commits into
Open
Conversation
Signed-off-by: Anna Rift <anna.rift@hpe.com>
Signed-off-by: Anna Rift <anna.rift@hpe.com>
Signed-off-by: Anna Rift <anna.rift@hpe.com>
bradcray
approved these changes
Jun 18, 2026
bradcray
left a comment
bradcray
left a comment
Member
There was a problem hiding this comment.
This looks great, thanks Anna! I don't think I've ever understood GitHub's blob/ paths well enough to have realized (consistently maybe) that this was an option.
Check my work, but I think I found a few blob-style URLs that could be made into true pointers to documentation, but only a few. Others either aren't part of the hierarchy that's rendered in the docs or pre-dated when we started rendering the developer/bestPractices content as part of the docs (or both).
| ----------------------------------------- | ||
| * added a draft style guide for standard modules | ||
| (see https://github.com/chapel-lang/chapel/blob/main/doc/rst/developer/bestPractices/StandardModuleStyle.rst) | ||
| (see https://github.com/chapel-lang/chapel/blob/release/1.25/doc/rst/developer/bestPractices/StandardModuleStyle.rst) |
Member
There was a problem hiding this comment.
Even better, I think this could be https://chapel-lang.org/docs/1.25/developer/bestPractices/StandardModuleStyle.html right?
| (see https://github.com/chapel-lang/chapel/blob/release/1.25/doc/rst/developer/bestPractices/StandardModuleStyle.rst) | ||
| * added notes about how Chapel web documentation is built | ||
| (see https://github.com/chapel-lang/chapel/blob/main/doc/rst/developer/bestPractices/buildingdocs.rst) | ||
| (see https://github.com/chapel-lang/chapel/blob/release/1.25/doc/rst/developer/bestPractices/buildingdocs.rst) |
Member
There was a problem hiding this comment.
| (see https://github.com/chapel-lang/chapel/blob/release/1.25/doc/rst/developer/bestPractices/buildingdocs.rst) | ||
| * added information about how to test PRs in the contributor guidelines | ||
| (see https://github.com/chapel-lang/chapel/blob/main/doc/rst/developer/bestPractices/ContributorInfo.rst#reviewer-responsibilities) | ||
| (see https://github.com/chapel-lang/chapel/blob/release/1.25/doc/rst/developer/bestPractices/ContributorInfo.rst#reviewer-responsibilities) |
Member
There was a problem hiding this comment.
| (see https://github.com/chapel-lang/chapel/blob/release/1.25/doc/rst/developer/bestPractices/ContributorInfo.rst#reviewer-responsibilities) | ||
| * generally cleaned up and streamlined the contributor guidelines | ||
| (see https://github.com/chapel-lang/chapel/blob/main/doc/rst/developer/bestPractices/ContributorInfo.rst) | ||
| (see https://github.com/chapel-lang/chapel/blob/release/1.25/doc/rst/developer/bestPractices/ContributorInfo.rst) |
Member
There was a problem hiding this comment.
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.
Update the following links in CHANGES.md:
mainunderhttps://github.com/chapel-lang/chapel/blob/main/-> link to blob on release branchhttps://chapel-lang/docs/->https://chapel-lang.org/docs/[reviewer info placeholder]
Testing:
brokfinds no broken links except historical URLs we want to keep