Skip to content

Curriculum/rust engineering add 5 frontmatter fields#6

Open
DRK28122006 wants to merge 3 commits into
Flow-Research:mainfrom
DRK28122006:curriculum/rust-engineering-add-5-frontmatter-fields
Open

Curriculum/rust engineering add 5 frontmatter fields#6
DRK28122006 wants to merge 3 commits into
Flow-Research:mainfrom
DRK28122006:curriculum/rust-engineering-add-5-frontmatter-fields

Conversation

@DRK28122006

@DRK28122006 DRK28122006 commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Summary

Describe the problem, the change, and the user/system impact.

Scope

  • In scope:
  • Out of scope:

Invariants

List the business and engineering rules that must remain true.

  • Canonical identity is defined where records/events are involved.
  • Re-running the operation does not duplicate effects.
  • Partial failure cannot silently corrupt state.
  • Public outputs do not expose private or internal data.

Design

Explain the source of truth, read/write boundaries, error behavior, and why this is the simplest safe approach.

Duplicate and idempotency review

  • Stable idempotency/dedupe key:
  • Persisted-data duplicate check:
  • Same-batch duplicate check:
  • Retry behavior:
  • Conflict behavior:

Privacy and security review

  • Data classification:
  • Public fields explicitly allowlisted:
  • Private links/identifiers suppressed:
  • Secrets and permissions reviewed:

Data, migration, and rollback

  • Schema/data changes:
  • Backup completed or not applicable:
  • Dry-run/preview result:
  • Expected affected-record count:
  • Rollback procedure:

Verification

  • Syntax/build/compile
  • Formatting/lint
  • Type checks
  • Unit tests
  • Integration tests
  • Repeat-run/idempotency test
  • Malformed-input test
  • Partial-failure test
  • Privacy-output test
  • Before/after reconciliation

Commands and actual results:


Operations

  • Configuration changes:
  • Deployment/restart steps:
  • Health checks:
  • Monitoring/alerts:
  • Post-deploy verification:

Agent declaration

  • I read the applicable AGENTS.md instructions.
  • I did not perform unapproved destructive production actions.
  • I have clearly stated any checks I could not run.
  • The patch does not include unrelated refactoring.

Summary by CodeRabbit

  • Documentation
    • Added structured course metadata across the Rust curriculum, including prerequisites, estimated duration, learning format, future topics, and related lessons.
    • Improved lesson planning details for hands-on activities, testing, videos, and capstone deliverables.
    • Updated documentation edit links so each lesson opens the corresponding source file for editing.

…Topics, Related_docs

Add 5 new frontmatter fields to all 19 lesson files in 06-rust-engineering
to match the schema in CONTRIBUTING.md and align with the broader
curriculum metadata convention.

Fields added per file:
- Prerequisites: prior lessons required
- Duration: time estimate for the lesson
- Format: short description of the lesson structure
- Future_Topics: topics to explore after this lesson
- Related_docs: relative links to related lessons

No body content changes.
@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 423e8c2a-232e-4ae4-ae41-0460802ef9bf

📥 Commits

Reviewing files that changed from the base of the PR and between f2fb926 and 0fdfb04.

📒 Files selected for processing (20)
  • curriculum/06-rust-engineering/01-rust-mindset-toolchain-engineering-loop.md
  • curriculum/06-rust-engineering/02-rust-syntax-fast-start.md
  • curriculum/06-rust-engineering/03-ownership-borrowing-lifetimes-memory-thinking.md
  • curriculum/06-rust-engineering/04-data-modeling-errors-control-flow.md
  • curriculum/06-rust-engineering/05-reuse-without-oop.md
  • curriculum/06-rust-engineering/06-modules-crates-workspaces-project-shape.md
  • curriculum/06-rust-engineering/07-smart-pointers-shared-state-concurrency.md
  • curriculum/06-rust-engineering/08-async-rust-and-tokio.md
  • curriculum/06-rust-engineering/09-axum-first-web-engineering.md
  • curriculum/06-rust-engineering/10-persistence-reusable-crud-sqlx.md
  • curriculum/06-rust-engineering/11-service-layer-architecture-domain-boundaries.md
  • curriculum/06-rust-engineering/12-application-framework-scaffolding-lab.md
  • curriculum/06-rust-engineering/13-testing-fixtures-code-review-culture.md
  • curriculum/06-rust-engineering/14-security-authentication-api-safety.md
  • curriculum/06-rust-engineering/15-observability-performance-deployment.md
  • curriculum/06-rust-engineering/16-beyond-backend-cli-data-protocols-wasm-embedded.md
  • curriculum/06-rust-engineering/17-macros-unsafe-advanced-escape-hatches.md
  • curriculum/06-rust-engineering/18-ai-assisted-rust-engineering.md
  • curriculum/06-rust-engineering/19-production-service-capstone.md
  • website/docusaurus.config.ts

📝 Walkthrough

Walkthrough

Changes

The Rust engineering curriculum lessons 01–19 now include structured front matter for prerequisites, duration, format, future topics, and related documentation. Docusaurus edit links are generated per document under the curriculum/ directory.

Rust curriculum documentation

Layer / File(s) Summary
Foundational lesson metadata
curriculum/06-rust-engineering/01-*.md through 06-*.md
Adds structured metadata to the first six Rust engineering lessons.
Intermediate lesson metadata
curriculum/06-rust-engineering/07-*.md through 12-*.md
Adds structured metadata to lessons covering concurrency, web engineering, persistence, architecture, and scaffolding.
Advanced lesson metadata
curriculum/06-rust-engineering/13-*.md through 19-*.md
Adds structured metadata to the remaining testing, security, deployment, advanced, AI-assisted, and capstone lessons.
Per-document edit links
website/docusaurus.config.ts
Changes editUrl to generate links from each document’s path under curriculum/.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: creativebash

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: adding five frontmatter fields across the Rust engineering curriculum.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.

1 participant