📜 Add v6.0.0 contracts documentation version #537

bot-anik · 2024-08-02T14:09:03Z

📜 Documentation update

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

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

Summary by CodeRabbit

New Features
- Introduced a sidebar configuration for dynamic generation based on directory content, improving navigation in documentation or user interfaces.
- Added a new version entry (v6.0.0) to the version history, allowing better tracking of updates.
Documentation Updates
- Updated hyperlinks in the Smart Contracts documentation to reflect current naming conventions, ensuring users access the correct resources.
- Modified the dropdown navigation items to direct users to the updated documentation version.

…ntation

vercel · 2024-08-02T14:09:05Z

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	Aug 5, 2024 9:35am

coderabbitai · 2024-08-02T14:09:10Z

Walkthrough

The recent updates introduce version 6.0.0 of the contracts, featuring a new sidebar configuration that automates documentation navigation based on directory content. Additionally, hyperlinks for key components have been updated to reflect new branding, enhancing clarity and accessibility. These changes collectively improve usability and ensure users can easily find the relevant information.

Changes

File Path	Change Summary
`contracts_versioned_sidebars/...version-v6.0.0-sidebars.json`, `contracts_versions.json`	New sidebar configuration added for auto-generated navigation; new version entry "v6.0.0" added.
`docs/technical-documentation/overview.mdx`	Hyperlinks updated to reflect new branding: "okp4" replaced with "axone."
`docusaurus.config.js`, `sidebars.js`	Links updated from `/contracts/okp4-cognitarium` to `/contracts/axone-cognitarium` in dropdown and sidebar.

Poem

In the garden of code, where changes bloom,
A sidebar now dances, dispelling the gloom.
Version six, like a rabbit, hops with delight,
Guiding each user through day and through night.
With every new update, we cheer and we play,
Embracing the changes, come hop, come what may! 🐇✨

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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 resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

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

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
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/schema.v2.json

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.

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 52b7609 and 29ce381.

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-v6.0.0/axone-cognitarium.md is excluded by !contracts_versioned_docs/**/*.md
contracts_versioned_docs/version-v6.0.0/axone-dataverse.md is excluded by !contracts_versioned_docs/**/*.md
contracts_versioned_docs/version-v6.0.0/axone-law-stone.md is excluded by !contracts_versioned_docs/**/*.md
contracts_versioned_docs/version-v6.0.0/axone-objectarium.md is excluded by !contracts_versioned_docs/**/*.md

Files selected for processing (2)

contracts_versioned_sidebars/version-v6.0.0-sidebars.json (1 hunks)
contracts_versions.json (1 hunks)

Files skipped from review due to trivial changes (2)

contracts_versioned_sidebars/version-v6.0.0-sidebars.json
contracts_versions.json

amimart

👍

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 29ce381 and 44fc077.

Files selected for processing (3)

docs/technical-documentation/overview.mdx (1 hunks)
docusaurus.config.js (1 hunks)
sidebars.js (1 hunks)

Files skipped from review due to trivial changes (3)

docs/technical-documentation/overview.mdx
docusaurus.config.js
sidebars.js

bot-anik

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

bdeneux · 2024-08-05T09:30:00Z

@amimart @ccamel Same here, fix broken link with new contract name

ccamel

👍

feat(contracts): add axone-protocol/contracts v6.0.0 contracts docume…

29ce381

…ntation

bot-anik added the documentation Improvements or additions to documentation label Aug 2, 2024

bot-anik assigned amimart and ccamel Aug 2, 2024

bot-anik requested review from amimart and ccamel August 2, 2024 14:09

coderabbitai bot reviewed Aug 2, 2024

View reviewed changes

amimart approved these changes Aug 2, 2024

View reviewed changes

vercel bot had a problem deploying to Preview August 2, 2024 14:19 Failure

fix(contract): broken link with new contract name

44fc077

coderabbitai bot reviewed Aug 5, 2024

View reviewed changes

bot-anik commented Aug 5, 2024

View reviewed changes

ccamel approved these changes Aug 5, 2024

View reviewed changes

vercel bot deployed to Preview August 5, 2024 09:35 View deployment

bdeneux merged commit a86e121 into main Aug 5, 2024
14 checks passed

bdeneux deleted the feat/contracts-v6.0.0 branch August 5, 2024 09:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

📜 Add v6.0.0 contracts documentation version #537

📜 Add v6.0.0 contracts documentation version #537

bot-anik commented Aug 2, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Aug 2, 2024 •

edited

Loading

coderabbitai bot commented Aug 2, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

amimart left a comment

coderabbitai bot left a comment

bot-anik left a comment

bdeneux commented Aug 5, 2024

ccamel left a comment

📜 Add v6.0.0 contracts documentation version #537

📜 Add v6.0.0 contracts documentation version #537

Conversation

bot-anik commented Aug 2, 2024 • edited by coderabbitai bot Loading

📜 Documentation update

Summary by CodeRabbit

vercel bot commented Aug 2, 2024 • edited Loading

coderabbitai bot commented Aug 2, 2024 • edited Loading

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

amimart left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

bot-anik left a comment

Choose a reason for hiding this comment

bdeneux commented Aug 5, 2024

ccamel left a comment

Choose a reason for hiding this comment

bot-anik commented Aug 2, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Aug 2, 2024 •

edited

Loading

coderabbitai bot commented Aug 2, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)