Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📜 Add v7.0.0 contracts documentation version #629

Merged
merged 1 commit into from
Dec 13, 2024
Merged

Conversation

bot-anik
Copy link
Member

@bot-anik bot-anik commented Dec 13, 2024

📜 Documentation update

🎉 A new version of axone-protocol/contracts is available.

This PR add this new v7.0.0 version into the documentation.

Summary by CodeRabbit

  • New Features
    • Introduced a new sidebar configuration for version 7.0.0, allowing for automatic generation of sidebar entries.
    • Added version entry "v7.0.0" to the version list.

@bot-anik bot-anik added the documentation Improvements or additions to documentation label Dec 13, 2024
Copy link

vercel bot commented Dec 13, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 13, 2024 10:14pm

Copy link
Contributor

coderabbitai bot commented Dec 13, 2024

Walkthrough

This pull request introduces a new JSON file named version-v7.0.0-sidebars.json in the contracts_versioned_sidebars directory, which defines a sidebar configuration for version 7.0.0. It specifies a defaultSidebar property that automatically generates sidebar entries based on the current directory. Additionally, the contracts_versions.json file is updated to include a new version entry, "v7.0.0".

Changes

File Change Summary
contracts_versioned_sidebars/version-v7.0.0-sidebars.json New file created with a defaultSidebar property for automatic sidebar generation.
contracts_versions.json New version entry "v7.0.0" added to the existing list of versions.

Possibly related PRs

Suggested reviewers

  • amimart
  • ccamel

🐰 In the garden, a sidebar grows,
With version seven, it surely shows.
Autogenerated, neat and bright,
Guiding our way, a lovely sight!
Hopping along, we celebrate,
New changes here, oh, isn’t it great? 🌼


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b50e305 and e18f04b.

⛔ Files ignored due to path filters (8)
  • contracts/axone-cognitarium.md is excluded by !contracts/**/*.md
  • contracts/axone-dataverse.md is excluded by !contracts/**/*.md
  • contracts/axone-law-stone.md is excluded by !contracts/**/*.md
  • contracts/axone-objectarium.md is excluded by !contracts/**/*.md
  • contracts_versioned_docs/version-v7.0.0/axone-cognitarium.md is excluded by !contracts_versioned_docs/**/*.md
  • contracts_versioned_docs/version-v7.0.0/axone-dataverse.md is excluded by !contracts_versioned_docs/**/*.md
  • contracts_versioned_docs/version-v7.0.0/axone-law-stone.md is excluded by !contracts_versioned_docs/**/*.md
  • contracts_versioned_docs/version-v7.0.0/axone-objectarium.md is excluded by !contracts_versioned_docs/**/*.md
📒 Files selected for processing (2)
  • contracts_versioned_sidebars/version-v7.0.0-sidebars.json (1 hunks)
  • contracts_versions.json (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • contracts_versions.json
  • contracts_versioned_sidebars/version-v7.0.0-sidebars.json

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

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Member Author

@bot-anik bot-anik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Device URL
desktop http://localhost:3000/

Device URL
mobile http://localhost:3000/

Not what you expected? Are your scores flaky? GitHub runners could be the cause.
Try running on Foo instead

Copy link
Member

@ccamel ccamel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm! 👍

@ccamel ccamel merged commit 095a680 into main Dec 13, 2024
15 checks passed
@ccamel ccamel deleted the feat/contracts-v7.0.0 branch December 13, 2024 22:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants