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 v4.0.0 ontology documentation version #543

Merged
merged 1 commit into from
Aug 8, 2024
Merged

Conversation

bot-anik
Copy link
Member

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

📜 Documentation update

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

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

Summary by CodeRabbit

  • New Features
    • Introduced a new autogenerated sidebar structure for improved navigation in the documentation system.
    • Added version entry "v4.0.0" to the ontology versioning system for enhanced clarity and usability.

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

vercel bot commented Aug 7, 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 7, 2024 1:54pm

Copy link
Contributor

coderabbitai bot commented Aug 7, 2024

Walkthrough

The recent updates introduce version 4.0.0 of the ontology, enhancing the documentation experience with an autogenerated sidebar that dynamically reflects the current directory's contents. This change improves navigation and content organization while retaining backward compatibility with the previous version, ensuring a seamless transition for users.

Changes

Files Change Summary
ontology_versioned_sidebars/version-v4.0.0-sidebars.json Added a new autogenerated sidebar configuration that dynamically includes items from the current directory.
ontology_versions.json Introduced a new version entry "v4.0.0" to the ontology versioning system, enhancing clarity while maintaining previous versions.

Poem

In a world of directories, neat and bright,
A sidebar jumps in, oh what a delight!
With version four, our paths intertwine,
Hopping through changes, everything's fine.
So let’s celebrate with a joyful cheer,
For seamless navigation, we hold so dear!
🐰✨


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.

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 70f7800 and 6d9d147.

Files ignored due to path filters (9)
  • ontology_versioned_docs/version-v4.0.0/schemas/credential-dataset-description.md is excluded by !ontology_versioned_docs/**/*.md
  • ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-resource-publication.md is excluded by !ontology_versioned_docs/**/*.md
  • ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-resource-rights.md is excluded by !ontology_versioned_docs/**/*.md
  • ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-service-authentication.md is excluded by !ontology_versioned_docs/**/*.md
  • ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-service-description.md is excluded by !ontology_versioned_docs/**/*.md
  • ontology_versioned_docs/version-v4.0.0/schemas/credential-governance-text.md is excluded by !ontology_versioned_docs/**/*.md
  • ontology_versioned_docs/version-v4.0.0/schemas/credential-orchestration-service-execution-order.md is excluded by !ontology_versioned_docs/**/*.md
  • ontology_versioned_docs/version-v4.0.0/schemas/credential-orchestration-service-execution.md is excluded by !ontology_versioned_docs/**/*.md
  • ontology_versioned_docs/version-v4.0.0/schemas/credential-zone-description.md is excluded by !ontology_versioned_docs/**/*.md
Files selected for processing (2)
  • ontology_versioned_sidebars/version-v4.0.0-sidebars.json (1 hunks)
  • ontology_versions.json (1 hunks)
Files skipped from review due to trivial changes (1)
  • ontology_versioned_sidebars/version-v4.0.0-sidebars.json
Additional comments not posted (1)
ontology_versions.json (1)

2-2: LGTM! The new version "v4.0.0" has been added correctly.

The JSON structure is valid, and the previous version "v3.0.0" remains intact, ensuring backward compatibility.

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.

👏

@amimart amimart force-pushed the feat/ontology-v4.0.0 branch from 6d9d147 to 5d7896d Compare August 7, 2024 13:46
@amimart
Copy link
Member

amimart commented Aug 7, 2024

@ccamel I just updated the docs according to: axone-protocol/ontology#295

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 6d9d147 and 5d7896d.

Files ignored due to path filters (9)
  • ontology_versioned_docs/version-v4.0.0/schemas/credential-dataset-description.md is excluded by !ontology_versioned_docs/**/*.md
  • ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-resource-publication.md is excluded by !ontology_versioned_docs/**/*.md
  • ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-resource-rights.md is excluded by !ontology_versioned_docs/**/*.md
  • ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-service-authentication.md is excluded by !ontology_versioned_docs/**/*.md
  • ontology_versioned_docs/version-v4.0.0/schemas/credential-digital-service-description.md is excluded by !ontology_versioned_docs/**/*.md
  • ontology_versioned_docs/version-v4.0.0/schemas/credential-governance-text.md is excluded by !ontology_versioned_docs/**/*.md
  • ontology_versioned_docs/version-v4.0.0/schemas/credential-orchestration-service-execution-order.md is excluded by !ontology_versioned_docs/**/*.md
  • ontology_versioned_docs/version-v4.0.0/schemas/credential-orchestration-service-execution.md is excluded by !ontology_versioned_docs/**/*.md
  • ontology_versioned_docs/version-v4.0.0/schemas/credential-zone-description.md is excluded by !ontology_versioned_docs/**/*.md
Files selected for processing (2)
  • ontology_versioned_sidebars/version-v4.0.0-sidebars.json (1 hunks)
  • ontology_versions.json (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • ontology_versioned_sidebars/version-v4.0.0-sidebars.json
  • ontology_versions.json

@amimart amimart merged commit 49014f7 into main Aug 8, 2024
14 checks passed
@amimart amimart deleted the feat/ontology-v4.0.0 branch August 8, 2024 07:45
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