PR1: Add release notes and changelogs to the sleap.ai website #1500
Conversation
shrivaths16
changed the title
WalkthroughA new workflow branch for SLEAP documentation updates has been introduced, and the SLEAP documentation itself has been enhanced with release notes for version 1.3.3 and a new navigation link for users to quickly find what's new. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChat with CodeRabbit Bot (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Files selected for processing (3)
- .github/workflows/website.yml (1 hunks)
- docs/bulletin.md (1 hunks)
- docs/index.rst (1 hunks)
Files skipped from review due to trivial changes (2)
- .github/workflows/website.yml
- docs/index.rst
Additional comments (Suppressed): 1
docs/bulletin.md (1)
- 1-74: The
bulletin.mdfile is well-structured and provides a comprehensive overview of the changes in SLEAP v1.3.2. It includes installation instructions, highlights of the new features, a full changelog, and acknowledgements to contributors. The links to the pull requests provide transparency and traceability for each change. This is a good practice as it allows users to easily find more detailed information about each change.
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Files selected for processing (1)
- docs/bulletin.md (1 hunks)
Additional comments (Suppressed): 1
docs/bulletin.md (1)
- 1-77: The new hunk for
docs/bulletin.mdprovides a comprehensive overview of the changes introduced in SLEAP v1.3.2. It includes installation instructions, highlights of the new features, a full changelog detailing enhancements and fixes, updates on dependencies, and acknowledgment of new contributors. The links to the pull requests provide transparency and traceability for each change. This is a well-structured and informative bulletin.
…om/talmolab/sleap into shrivaths/changelog-announcement-1
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (2)
- docs/bulletin.md (1 hunks)
- docs/index.rst (1 hunks)
Additional comments: 5
docs/bulletin.md (4)
1-7: The introduction of the release notes for SLEAP v1.3.3 is clear and concise. The explanation of the brown-bag release and the issues it addresses is well-documented.
9-21: The installation instructions and reminders for SLEAP v1.3.3 are detailed and provide clear guidance for users. However, ensure that the installation commands are tested and verified to work as expected.
23-50: The quick install commands and the full changelog link for SLEAP v1.3.3 are well-placed and formatted. It's important to ensure that the provided URLs and commands are accurate and functional.
58-128: The release notes for SLEAP v1.3.2 are comprehensive, including highlights, enhancements, fixes, dependencies, and new contributors. Ensure that all links are correct and that the contributions are accurately attributed.
docs/index.rst (1)
- 20-20: The addition of the "What's new" link to the table of contents in
index.rstis correctly formatted and will help users find the latest information on SLEAP updates.
docs/bulletin.md
Outdated
| ## SLEAP v1.3.2 | ||
|
|
||
| _mm/dd/yyyy_ |
There was a problem hiding this comment.
The date placeholder _mm/dd/yyyy_ for SLEAP v1.3.2 should be replaced with the actual release date to maintain consistency and provide complete information.
- _mm/dd/yyyy_
+ 03/15/2023 # Example date, replace with the actual release dateCommittable suggestion
❗ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| ## SLEAP v1.3.2 | |
| _mm/dd/yyyy_ | |
| ## SLEAP v1.3.2 | |
| 03/15/2023 # Example date, replace with the actual release date |
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (1)
- docs/bulletin.md (1 hunks)
Additional comments: 4
docs/bulletin.md (4)
3-50: The release notes for SLEAP v1.3.3 are well-documented, providing clear information on the issues addressed, installation instructions, and links to the full changelog. The use of bold text for the pip installation command is a good way to highlight important information.
50-50: Including a link to the full changelog is a good practice for maintaining traceability and providing users with a way to explore all changes in detail.
54-56: The addition of the date for SLEAP v1.3.2 is consistent with the previous suggestion by roomrys. Ensure that all future updates to
bulletin.mdare made in the correct branch to keep changes organized.54-128: The release notes for SLEAP v1.3.2 are comprehensive, including highlights, fixes, dependencies, and new contributors. This level of detail is beneficial for users to understand the impact of the new version.
| ### Quick install | ||
| **`mamba` (Windows/Linux/GPU)**: | ||
| ``` | ||
| mamba create -y -n sleap -c conda-forge -c nvidia -c sleap -c anaconda sleap=1.3.3 | ||
| ``` | ||
|
|
||
| **`mamba` (Mac)**: | ||
| ``` | ||
| mamba create -y -n sleap -c conda-forge -c anaconda -c sleap sleap=1.3.3 | ||
| ``` | ||
|
|
||
| **`pip` (any OS except Apple Silicon)**: | ||
| ``` | ||
| pip install sleap[pypi]==1.3.3 | ||
| ``` |
There was a problem hiding this comment.
Consider abstracting the installation instructions for mamba and pip to a common section to avoid duplication across different version release notes.
Description
Add
bulletin.mdfile to the docs folder and update theindex.rstappropriately with the bulletin file to be displayed on the sleap.ai website.This is the first of the four PRs that are needed to complete this discussion #1492.
Types of changes
Does this address any currently open issues?
Outside contributors checklist
Thank you for contributing to SLEAP!
❤️
Summary by CodeRabbit