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

chore: fixed broken links #375

Merged
merged 4 commits into from
Mar 28, 2025
Merged

chore: fixed broken links #375

merged 4 commits into from
Mar 28, 2025

Conversation

youyyytrok
Copy link
Contributor

Is this resolving a feature or a bug?

Hi! I resolves bugs related to broken links and improves the overall quality of the documentation by ensuring all links are functional and properly formatted.

Are there existing issue(s) that this PR would close?

  • No existing issues are being closed by this PR.

If this PR is not minimal (it could be split into multiple PRs), please explain why the issues are best resolved together.

  • The changes are related to documentation and formatting.

Describe your changes.

  1. runtime/README.md:

    • Fixed the broken documentation link by adding the https:// protocol.
  2. vm/src/riscv/instructions/instruction.rs:

    • Updated the links to the RISC-V opcodes to point to the correct locations in the riscv-opcodes repository.

@sjudson
Copy link
Contributor

sjudson commented Mar 28, 2025

@youyyytrok Thanks for the fixes. As part of our new licensing, we require signing a contributor license agreement in order to contribute to the the codebase.

If you rebase this PR off main the bot will activate and walk you through the (very straightforward) process to sign the CLA.

Copy link

github-actions bot commented Mar 28, 2025

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@youyyytrok
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@youyyytrok
Copy link
Contributor Author

Hi @sjudson! Done.

Copy link
Contributor

@sjudson sjudson left a comment

Choose a reason for hiding this comment

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

Minor, but otherwise LGTM.

@@ -68,7 +68,7 @@ function directly. The fourth line brings the nexux-rt
`main` function as the starting point of the program.

To see more, such as how to introduce program i/o, precompiles,
and native compilation support, check out our [documentation](docs.nexus.xyz).
and native compilation support, check out our [documentation](https://docs.nexus.xyz).
Copy link
Contributor

Choose a reason for hiding this comment

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

Would you be able to align this with the main repo readme, which points to https://docs.nexus.xyz/zkvm/index?

@youyyytrok youyyytrok requested a review from sjudson March 28, 2025 20:01
@sjudson sjudson merged commit 5d2e394 into nexus-xyz:main Mar 28, 2025
8 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Mar 28, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants