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

Build/predicates doc #340

Merged
merged 2 commits into from
Oct 29, 2023
Merged

Build/predicates doc #340

merged 2 commits into from
Oct 29, 2023

Conversation

ccamel
Copy link
Member

@ccamel ccamel commented Oct 28, 2023

Following axone-protocol/axoned#469, configure docusaurus to display the predicates documentation.

image

Summary by CodeRabbit

  • New Feature: Introduced a dropdown menu in the 'predicates' section of our documentation. This new feature enhances navigation and allows users to quickly access the 'Latest version' of the predicates documentation.
  • Documentation: Added a new "Governance Predicates" link to the sidebar. This update provides users with a direct and convenient path to important governance predicate information.

@ccamel ccamel self-assigned this Oct 28, 2023
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 28, 2023

Walkthrough

The recent changes have introduced a new dropdown menu in the 'predicates' documentation section of our Docusaurus project. This dropdown menu, labeled 'Latest version', links to '/predicates/predicates'. Additionally, a new sidebar link titled "Governance Predicates" has been added, enhancing the navigation experience.

Changes

File Summary
docusaurus.config.js Added a new dropdown menu configuration in the 'predicates' documentation section.
.../sidebars.js Introduced a new sidebar link "Governance Predicates".

🐇💻

In the land of code, where the rabbits play,

A new dropdown menu found its way.

"Latest version", it proudly displays,

Guiding users through the documentation maze.

And in the sidebar, a new link takes its place,

"Governance Predicates", enhancing the space.

So hop along, explore, and see,

The changes made, as easy as one, two, three! 🎉


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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 help to get help.
  • @coderabbitai resolve to resolve all the CodeRabbit review comments.

Note: For conversation with the bot, please use the review comments on code diffs or files.

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.json

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 526205e and c401e8a.
Files ignored due to filter (1)
  • predicates_versions.json
Files selected for processing (2)
  • docusaurus.config.js (2 hunks)
  • sidebars.js (1 hunks)
Files skipped from review due to trivial changes (2)
  • docusaurus.config.js
  • sidebars.js

@ccamel ccamel requested a review from amimart October 28, 2023 09:20
Copy link
Member

@amimart amimart left a comment

Choose a reason for hiding this comment

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

Can't wait to see it 😍

@ccamel ccamel merged commit 5b19b6f into main Oct 29, 2023
11 checks passed
@ccamel ccamel deleted the build/predicates-doc branch October 29, 2023 06:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants