Skip to content

Website: update Rust reference #1526

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 9, 2025
Merged

Website: update Rust reference #1526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1746fc7
Website: update Rust reference
dannywillems Oct 9, 2025
a565e48
CI/docs: update comments when the links in the docs are valid
dannywillems Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/scripts/verify-code-references.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,22 @@ echo ""

if [[ $EXIT_CODE -eq 0 ]]; then
echo -e "${GREEN}✓ All code references are valid!${NC}"

# If in PR comment mode, write success message to file
if [[ -n "${COMMENT_FILE}" ]]; then
cat > "${COMMENT_FILE}" <<EOF
## ✓ Code Reference Verification Passed

All code references in the documentation have been verified successfully!

**Total references checked:** ${TOTAL_REFS}
**Valid references:** ${VALID_REFS}

The documentation is in sync with the codebase on the \`develop\` branch.
EOF
echo ""
echo "PR success comment written to: ${COMMENT_FILE}"
fi
else
echo -e "${RED}✗ Some code references are invalid. Please update the documentation.${NC}"

Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,16 +57,16 @@ jobs:
run: |
bash .github/scripts/verify-code-references.sh --pr-comment /tmp/pr-comment.md
if [ -f /tmp/pr-comment.md ]; then
echo "has_errors=true" >> $GITHUB_OUTPUT
echo "has_comment=true" >> $GITHUB_OUTPUT
echo "Comment file created, will post to PR"
cat /tmp/pr-comment.md
else
echo "has_errors=false" >> $GITHUB_OUTPUT
echo "No errors found, no comment needed"
echo "has_comment=false" >> $GITHUB_OUTPUT
echo "No comment file created"
fi

- name: Comment PR on verification failure
if: github.event_name == 'pull_request' && steps.verify-pr.outputs.has_errors == 'true'
- name: Comment PR with verification results
if: github.event_name == 'pull_request' && steps.verify-pr.outputs.has_comment == 'true'
uses: thollander/actions-comment-pull-request@v3
with:
file-path: /tmp/pr-comment.md
Expand Down
6 changes: 3 additions & 3 deletions website/docs/developers/documentation-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ https://github.com/o1-labs/mina-rust/blob/develop/path/to/file.rs#LStartLine-LEn

Here's a real example from the zkApps documentation:

<!-- CODE_REFERENCE: ledger/src/scan_state/transaction_logic.rs#L3588-L3592 -->
<!-- CODE_REFERENCE: ledger/src/scan_state/transaction_logic/valid.rs#L80-L83-->

```rust reference title="ledger/src/scan_state/transaction_logic.rs"
https://github.com/o1-labs/mina-rust/blob/develop/ledger/src/scan_state/transaction_logic.rs#L3588-L3592
```rust reference title="ledger/src/scan_state/transaction_logic/valid.rs"
https://github.com/o1-labs/mina-rust/blob/develop/ledger/src/scan_state/transaction_logic/valid.rs#L80-L83
```

### Components explained
Expand Down
Loading