Skip to content

Render each guideline as a standalone page#385

Merged
PLeVasseur merged 1 commit intorustfoundation:mainfrom
PLeVasseur:issue-284-guidelines-standalone-pages
Jan 30, 2026
Merged

Render each guideline as a standalone page#385
PLeVasseur merged 1 commit intorustfoundation:mainfrom
PLeVasseur:issue-284-guidelines-standalone-pages

Conversation

@PLeVasseur
Copy link
Collaborator

Summary

  • Replace guideline include files with standalone guideline pages and chapter toctrees
  • Update guideline tooling and scans to handle .rst pages directly
  • Fix linkcheck flag behavior and a bibliography URL used in validation

Testing

  • uv run ruff check --fix
  • uv run python generate_guideline_templates.py --number-of-templates 1
  • gh issue view 135 --repo rustfoundation/safety-critical-rust-coding-guidelines --json number,title,body | uv run python scripts/guideline-from-issue.py
  • gh issue view 135 --repo rustfoundation/safety-critical-rust-coding-guidelines --json number,title,body | uv run python scripts/generate-rst-comment.py
  • uv run python scripts/split_guidelines.py --dry-run --all --update-index
  • uv run python scripts/migrate_rust_examples.py --dry-run
  • uv run python scripts/extract_rust_examples.py --extract
  • uv run python scripts/extract_rust_examples.py --test
  • uv run python scripts/fls_audit.py --summary-only
  • uv run pytest
  • uv run python make.py
  • uv run python make.py --xml
  • uv run python make.py --debug
  • uv run python make.py --offline
  • uv run python make.py --ignore-spec-lock-diff
  • uv run python make.py --check-links
  • uv run python make.py --validate-urls
  • timeout 5s uv run python make.py --serve
  • Manual audit: scripts/fls_audit_issue.py, scripts/reviewer_bot.py

Closes #284

@netlify
Copy link

netlify bot commented Jan 30, 2026

Deploy Preview for scrc-coding-guidelines ready!

Name Link
🔨 Latest commit 8562a1d
🔍 Latest deploy log https://app.netlify.com/projects/scrc-coding-guidelines/deploys/697c2aed2e3f270008c19c3b
😎 Deploy Preview https://deploy-preview-385--scrc-coding-guidelines.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@PLeVasseur PLeVasseur merged commit ea44d3e into rustfoundation:main Jan 30, 2026
16 checks passed
@PLeVasseur PLeVasseur deleted the issue-284-guidelines-standalone-pages branch January 30, 2026 03:53
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.

Should: 1. each chapter contain all guidelines or 2. a flat list linking to them and each guideline is its own page?

1 participant