Update repo descriptions, attribution, and how to use #50
Conversation
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
also update release date and version
egrace479
requested review from
NetZissou,
gwtaylor,
hlapp,
ieyriay and
thompsonmj
egrace479
added
design
egrace479
commented
Jun 17, 2025
particularly, includes mention of ABC
- Change "Checkout" to "Check out" - Remove hyphen from "broadly-applicable" - Change "Acknowledgement" to "Acknowledgments"
- Remove duplicate edit_uri field - Standardize edit_uri to use edit/main/docs/ pattern - Add individual comments to each personalizable field - Improve comment consistency and clarity
gwtaylor
approved these changes
Jun 26, 2025
There was a problem hiding this comment.
Review Summary
I've reviewed this PR and made the following changes:
README.md
- Replaced "web site" with "website" to modernize terminology
- Improved tone and clarity by refining language and fixing typos
- Enhanced consistency in explanations and formatting
mkdocs.yaml
- Removed duplicate
edit_urientry and standardized the path - Improved comments for clarity and consistency
- Ensured all personalizable fields have specific comments
Approved for merge.
5 tasks
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.
Closes #44.
mkdocs.yamlabout how to personalize the site and include proper attribution.READMEto how to interact with and use the template repo, includes joint acknowledgment statement.CITATION.cff, sets version and description for Collaborative Distributed Science Guide (distinct from Imageomics-Guide, see explanation in Ondev:READMEandmkdocs.yamledits #44).This is a joint-review request since everyone's name is being added here and it's about presentation of the guide.