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 v10.0.0 modules documentation version #560

Merged
merged 1 commit into from
Aug 29, 2024
Merged

Conversation

bot-anik
Copy link
Member

@bot-anik bot-anik commented Aug 29, 2024

📜 Documentation update

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

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

Summary by CodeRabbit

  • New Features
    • Introduced a new sidebar configuration for versioned documentation, enhancing navigation and content presentation.
    • Added a new version entry "v10.0.0" to the module versioning, indicating the latest updates and improvements.

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

vercel bot commented Aug 29, 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 Aug 29, 2024 9:49am

Copy link
Contributor

coderabbitai bot commented Aug 29, 2024

Walkthrough

The changes introduce a new version, "v10.0.0," to the documentation system, including the addition of a sidebar configuration file that facilitates autogenerated sidebar content. This configuration enhances the documentation's navigational structure while maintaining the existing versioning format.

Changes

Files Change Summary
modules_versioned_sidebars/version-v10.0.0-sidebars.json, modules_versions.json Introduced version-v10.0.0-sidebars.json for autogenerated sidebar configuration and added "v10.0.0" entry in modules_versions.json.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DocumentationSystem
    participant SidebarGenerator

    User->>DocumentationSystem: Request documentation
    DocumentationSystem->>SidebarGenerator: Generate sidebar
    SidebarGenerator-->>DocumentationSystem: Return autogenerated sidebar
    DocumentationSystem-->>User: Display documentation with sidebar
Loading

🐰 "In the garden, new paths we tread,
A version blooms, with joy ahead.
Sidebars dance, content in line,
Hop along, all will be fine!
With every change, we leap and play,
A brighter doc for every day!" 🌼


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 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 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
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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 f67f0f8 and 4c8c9ee.

Files ignored due to path filters (3)
  • modules_versioned_docs/version-v10.0.0/logic.md is excluded by !modules_versioned_docs/**/*.md
  • modules_versioned_docs/version-v10.0.0/mint.md is excluded by !modules_versioned_docs/**/*.md
  • modules_versioned_docs/version-v10.0.0/vesting.md is excluded by !modules_versioned_docs/**/*.md
Files selected for processing (2)
  • modules_versioned_sidebars/version-v10.0.0-sidebars.json (1 hunks)
  • modules_versions.json (1 hunks)
Files skipped from review due to trivial changes (2)
  • modules_versioned_sidebars/version-v10.0.0-sidebars.json
  • modules_versions.json

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

@amimart amimart merged commit f366c03 into main Aug 29, 2024
14 checks passed
@amimart amimart deleted the feat/modules-v10.0.0 branch August 29, 2024 15:19
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