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

fix(api-reference): correct link to ontology #598

Merged
merged 1 commit into from
Nov 11, 2024
Merged

Conversation

ccamel
Copy link
Member

@ccamel ccamel commented Nov 10, 2024

Self explanatory.

Summary by CodeRabbit

  • Documentation
    • Updated the hyperlink in the "Ontology" section of the API reference documentation to reflect a broader schema description.

@ccamel ccamel requested a review from AnjaMis November 10, 2024 17:29
@ccamel ccamel self-assigned this Nov 10, 2024
Copy link

vercel bot commented Nov 10, 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 Nov 10, 2024 5:32pm

Copy link
Contributor

coderabbitai bot commented Nov 10, 2024

Walkthrough

The changes involve an update to the API reference documentation for the Axone Protocol. Specifically, the hyperlink in the "Ontology" section has been modified to redirect from a specific predicate URL to a broader schema description URL. The rest of the documentation remains unchanged, preserving the existing structure and content.

Changes

File Change Summary
docs/api-reference/api-reference.mdx Updated hyperlink in "Ontology" section from /predicates/bank_balances_2 to /ontology/schemas/credential-dataset-description.

Suggested reviewers

  • amimart
  • AnjaMis

Poem

In the land of code where rabbits hop,
A link was changed, and we can't stop!
From predicates to schemas, oh what a sight,
Guiding us forward, through day and night.
With each little change, our docs shine bright! 🐇✨


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

@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
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: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f340419 and 494c200.

📒 Files selected for processing (1)
  • docs/api-reference/api-reference.mdx (1 hunks)
🔇 Additional comments (1)
docs/api-reference/api-reference.mdx (1)

89-89: LGTM! The ontology link update is appropriate.

The change from a specific predicate to the schema description page is more suitable for the Ontology section, as it provides a broader overview of the ontology structure rather than a specific predicate implementation.

docs/api-reference/api-reference.mdx Show resolved Hide resolved
@ccamel ccamel merged commit 217f4ce into main Nov 11, 2024
15 checks passed
@ccamel ccamel deleted the fix/ontology-link branch November 11, 2024 10:55
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.

3 participants