sleap icon indicating copy to clipboard operation
sleap copied to clipboard
verified publisher icon talmolab

PR1: Add release notes and changelogs to the sleap.ai website

Open shrivaths16 opened this issue 2 years ago • 1 comments

Description

Add bulletin.md file to the docs folder and update the index.rst appropriately 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

  • [ ] Bugfix
  • [ ] New feature
  • [ ] Refactor / Code style update (no logical changes)
  • [ ] Build / CI changes
  • [ ] Documentation Update
  • [ ] Other (explain)

Does this address any currently open issues?

  • #1563

Outside contributors checklist

  • [ ] Review the guidelines for contributing to this repository
  • [ ] Read and sign the CLA and add yourself to the authors list
  • [ ] Make sure you are making a pull request against the develop branch (not main). Also you should start your branch off develop
  • [ ] Add tests that prove your fix is effective or that your feature works
  • [ ] Add necessary documentation (if appropriate)

Thank you for contributing to SLEAP!

:heart:

Summary by CodeRabbit

  • Documentation
    • Updated the workflow to include changes in the documentation and README.
    • Released bulletin with release notes for SLEAP version 1.3.3, covering new changes, fixes, and dependency updates.
    • Added a "What's new" section in the documentation for easier access to the latest updates.

shrivaths16 avatar Sep 14 '23 11:09 shrivaths16

Walkthrough

A 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

File Path Change Summary
.github/workflows/.../website.yml Added "shrivaths/changelog-announcement-1" branch trigger for workflow
docs/bulletin.md Documented release notes for SLEAP v1.3.3
docs/index.rst Added "What's new" link to navigation

🐇✨ In the burrows of code, a new path does wind,
A changelog grows, with version outlined.
Click "What's new", for updates you'll find,
A SLEAP forward, for machine learning refined.
🌟📜

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?

Share
Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • You can directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • You can tag CodeRabbit on specific lines of code or entire files in the PR by tagging @coderabbitai in a comment. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • You can tag @coderabbitai in a PR comment and ask questions about the PR and the codebase. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid.
    • @coderabbitai read the files in the src/scheduler package and generate README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai[bot] avatar Sep 28 '23 16:09 coderabbitai[bot]