Updated the docs as part of integration #1193
Merged
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates documentation across the repository as part of an integration effort. The changes focus on standardizing branding terminology, simplifying markdown formatting, updating contact information, and correcting minor formatting issues.
Changes:
- Standardized branding from "HED Python tools" to "Python HEDTools" across documentation
- Removed bold markdown formatting from link text in documentation and notebooks for consistency
- Updated contact information to point to HED organization discussions and new maintainer email
- Fixed formatting issue in CHANGELOG.md and updated .gitmodules branch reference
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
examples/extract_json_template.ipynb |
Removed bold formatting from link text for consistency |
docs/user_guide.md |
Updated title, removed bold from links, changed "Online tools" to "Web tools" |
docs/overview.md |
Updated title, added NWB and format support bullets, updated contact info with discussions link |
docs/index.rst |
Simplified structure, updated section titles, removed sidebar and unnecessary index entries |
docs/api/index.rst |
Updated title to match new branding |
docs/_templates/sidebar/brand.html |
Updated sidebar branding text to "Python HEDTools" |
CONTRIBUTING.md |
Added discussions link, updated maintainer email contact |
CHANGELOG.md |
Fixed markdown formatting by removing extra backticks |
.gitmodules |
Changed hed-examples branch from develop to main |
Comments suppressed due to low confidence (1)
docs/overview.md:107
- The GitHub organization URL should be
hed-standard(with hyphen), nothedstandard. This is inconsistent with all other references to the HED organization in the codebase. The correct URL should behttps://github.com/orgs/hed-standard/discussions.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
No description provided.