Skip to content

Curriculum/add 5 frontmatter fields all sections#12

Open
DRK28122006 wants to merge 13 commits into
Flow-Research:mainfrom
DRK28122006:curriculum/add-5-frontmatter-fields-all-sections
Open

Curriculum/add 5 frontmatter fields all sections#12
DRK28122006 wants to merge 13 commits into
Flow-Research:mainfrom
DRK28122006:curriculum/add-5-frontmatter-fields-all-sections

Conversation

@DRK28122006

@DRK28122006 DRK28122006 commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds 5 new frontmatter fields (Prerequisites, Duration, Format, Future_Topics, Related_docs) to all 90
lesson files across the 6 curriculum sections, matching the schema in CONTRIBUTING.md.

For 05-products and 07-agent-systems, also adds the missing track and level fields (and version for
products).

Strictly frontmatter-only changes — no body edits, no index.md changes, no _category_.json changes.

Scope

  • 02-Blockchain: 18 files
  • 03-AI-ML: 19 files (04-cnn.md kept at v1.0)
  • 04-Protocol Engineering: 18 files
  • 05-products: 9 files (added track: products, level, version: 1.0)
  • 06-rust-engineering: 19 files
  • 07-agent-systems: 7 files (added track: agent-systems, level)

Summary by CodeRabbit

  • Documentation
    • Added consistent lesson metadata across blockchain, AI/ML, protocol engineering, product, Rust, and agent-systems curriculum pages.
    • Lessons now include prerequisites, estimated duration, recommended format, future topics, and related learning resources.
    • Added track, level, and version details where applicable.
    • Existing instructional content remains unchanged.

…, Related_docs

Add 5 new frontmatter fields to all 18 lesson files in 02-Blockchain 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.
…ated_docs

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

Note: 04-cnn.md remains on version: 1.0 (its body still uses the older
template; a future PR can promote it to v1.1 with the matching body
changes). Only the 5 new frontmatter fields are added; the version
field is unchanged.

No body content changes.
…ure_Topics, Related_docs

Add 5 new frontmatter fields to all 18 lesson files in 04-Protocol
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.
Add track, level, version plus Prerequisites, Duration, Format,
Future_Topics, Related_docs to all 9 lesson files in 05-products.

The 05-products section previously had only id and title in its
frontmatter. This brings the section up to the same metadata standard
as the rest of the curriculum (blockchain, ai-ml, protocol-engineering,
rust-engineering, agent-systems).

Fields added per file:
- track: products
- level: foundation (00-value-engine, 00-personal-operator, 01-jarvis,
  02-garden, 03-workstream, 04-harnessy, 05-flowledger) or
  intermediate (06-economic-incentive-design, 07-security-trust-engineering)
- version: 1.0
- 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.
…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.
Add track, level plus Prerequisites, Duration, Format, Future_Topics,
Related_docs to all 7 lesson files in 07-agent-systems.

The 07-agent-systems section previously had only id, title, and version
in its frontmatter. This brings the section up to the same metadata
standard as the rest of the curriculum.

Fields added per file:
- track: agent-systems
- level: beginner or intermediate or advanced
- Prerequisites, Duration, Format, Future_Topics, Related_docs

No body content changes.
…, Related_docs

Part of combined PR adding 5 new frontmatter fields to all 6
curriculum sections. See PR description for the full scope.
…ated_docs

Part of combined PR adding 5 new frontmatter fields to all 6
curriculum sections. See PR description for the full scope.
…ure_Topics, Related_docs

Part of combined PR adding 5 new frontmatter fields to all 6
curriculum sections. See PR description for the full scope.
Also adds the missing track (products), level (foundation|intermediate),
and version (1.0) fields that were absent from these lesson files.
Part of combined PR adding 5 new frontmatter fields to all 6
curriculum sections. See PR description for the full scope.
…Topics, Related_docs

Part of combined PR adding 5 new frontmatter fields to all 6
curriculum sections. See PR description for the full scope.
Also adds the missing track (agent-systems) and level
(beginner|intermediate|advanced) fields that were absent from these
lesson files. Part of combined PR adding 5 new frontmatter fields to
all 6 curriculum sections. See PR description for the full scope.
@coderabbitai

coderabbitai Bot commented Jul 23, 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: d8d94d1a-a90c-464f-9637-ece977da1c55

📥 Commits

Reviewing files that changed from the base of the PR and between b07a298 and 3f8c37f.

📒 Files selected for processing (1)
  • curriculum/02-Blockchain/03-advanced/01-protocol-engineering/02-consensus-tuning.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • curriculum/02-Blockchain/03-advanced/01-protocol-engineering/02-consensus-tuning.md

📝 Walkthrough

Walkthrough

The PR adds standardized curriculum metadata to lesson and product Markdown pages across six curriculum areas. Fields cover prerequisites, duration, format, future topics, related documents, and, for selected pages, track, level, and version.

Changes

Curriculum metadata rollout

Layer / File(s) Summary
Blockchain and AI/ML metadata
curriculum/02-Blockchain/..., curriculum/03-AI-ML/...
Adds prerequisite, duration, format, future-topic, and related-document metadata to blockchain and AI/ML lessons.
Protocol engineering and product metadata
curriculum/04-Protocol Engineering/..., curriculum/05-products/...
Adds lesson metadata across protocol engineering pages and full classification metadata, including track, level, and version, to product pages.
Rust engineering metadata
curriculum/06-rust-engineering/*
Adds structured learning metadata and related-document references to Rust engineering modules.
Agent-systems metadata
curriculum/07-agent-systems/*
Adds curriculum classification and learning metadata to agent-systems lessons.

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

Possibly related PRs

  • Flow-Research/learn#6: Updates overlapping Rust curriculum frontmatter fields and related site configuration.
🚥 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 reflects the main change: adding standardized frontmatter fields across curriculum sections.
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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In
`@curriculum/02-Blockchain/03-advanced/01-protocol-engineering/02-consensus-tuning.md`:
- Line 10: Update the Future_Topics metadata value to remove the section prefix
from “04-Protocol Engineering Consensus Economics,” using the canonical topic
label “Consensus Economics” or its established linked identifier while
preserving the other topics.

In `@curriculum/04-Protocol`
Engineering/02-intermediate/02-governance-and-ecosystem/01-upgrade-paths.md:
- Around line 11-14: Normalize the Related_docs entries to valid canonical
repository paths or Markdown/URL links, ensuring every referenced document
resolves and follows the repository’s relative-link convention. Apply this to
curriculum/04-Protocol
Engineering/02-intermediate/02-governance-and-ecosystem/01-upgrade-paths.md:11-14,
curriculum/04-Protocol
Engineering/02-intermediate/02-governance-and-ecosystem/02-interchain-protocols.md:11-14,
curriculum/04-Protocol
Engineering/02-intermediate/02-governance-and-ecosystem/03-community-feedback.md:11-14,
curriculum/04-Protocol
Engineering/03-advanced/01-lead-architect/01-optimizing-latency.md:11-14,
curriculum/04-Protocol
Engineering/03-advanced/01-lead-architect/02-consensus-economics.md:11-14,
curriculum/04-Protocol
Engineering/03-advanced/01-lead-architect/03-security-modeling.md:11-15,
curriculum/04-Protocol
Engineering/03-advanced/02-global-adoption/01-regulatory-compliance.md:11-14,
curriculum/04-Protocol
Engineering/03-advanced/02-global-adoption/02-performance-auditing.md:11-14, and
curriculum/04-Protocol
Engineering/03-advanced/02-global-adoption/03-enterprise-integration.md:11-14;
update each affected Related_docs list rather than retaining bare path
fragments.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 9c95766f-6496-4343-bdb2-4196a1411f3d

📥 Commits

Reviewing files that changed from the base of the PR and between 7dd6048 and b07a298.

📒 Files selected for processing (90)
  • curriculum/02-Blockchain/01-beginner/01-fundamentals/01-what-is-blockchain.md
  • curriculum/02-Blockchain/01-beginner/01-fundamentals/02-key-terms-and-models.md
  • curriculum/02-Blockchain/01-beginner/01-fundamentals/03-consensus-overview.md
  • curriculum/02-Blockchain/01-beginner/02-ecosystem/01-layer-1-vs-layer-2.md
  • curriculum/02-Blockchain/01-beginner/02-ecosystem/02-tokens-and-economic-incentives.md
  • curriculum/02-Blockchain/01-beginner/02-ecosystem/03-decentralized-identity.md
  • curriculum/02-Blockchain/02-intermediate/01-smart-contracts/01-solidity-and-vyper-basics.md
  • curriculum/02-Blockchain/02-intermediate/01-smart-contracts/02-contract-design-patterns.md
  • curriculum/02-Blockchain/02-intermediate/01-smart-contracts/03-testing-and-deployment.md
  • curriculum/02-Blockchain/02-intermediate/02-security/01-common-vulns.md
  • curriculum/02-Blockchain/02-intermediate/02-security/02-code-audit-practices.md
  • curriculum/02-Blockchain/02-intermediate/02-security/03-pen-test-workflow.md
  • curriculum/02-Blockchain/03-advanced/01-protocol-engineering/01-protocol-architecture.md
  • curriculum/02-Blockchain/03-advanced/01-protocol-engineering/02-consensus-tuning.md
  • curriculum/02-Blockchain/03-advanced/01-protocol-engineering/03-governance-mechanisms.md
  • curriculum/02-Blockchain/03-advanced/02-scalability/01-state-channels.md
  • curriculum/02-Blockchain/03-advanced/02-scalability/02-rollups-and-sharding.md
  • curriculum/02-Blockchain/03-advanced/02-scalability/03-interoperability-design.md
  • curriculum/03-AI-ML/01-beginner/01-foundations/01-math-for-ml.md
  • curriculum/03-AI-ML/01-beginner/01-foundations/02-data-pipelines-basics.md
  • curriculum/03-AI-ML/01-beginner/01-foundations/03-model-lifecycle.md
  • curriculum/03-AI-ML/01-beginner/02-tools/01-python-ecosystem.md
  • curriculum/03-AI-ML/01-beginner/02-tools/02-notebooks-and-visualization.md
  • curriculum/03-AI-ML/01-beginner/02-tools/03-ml-libraries.md
  • curriculum/03-AI-ML/02-intermediate/01-supervised-learning/01-regression-classification.md
  • curriculum/03-AI-ML/02-intermediate/01-supervised-learning/02-feature-engineering.md
  • curriculum/03-AI-ML/02-intermediate/01-supervised-learning/03-hyperparameter-tuning.md
  • curriculum/03-AI-ML/02-intermediate/02-mlops/01-ci-cd-for-models.md
  • curriculum/03-AI-ML/02-intermediate/02-mlops/02-monitoring-and-drift.md
  • curriculum/03-AI-ML/02-intermediate/02-mlops/03-deployment-patterns.md
  • curriculum/03-AI-ML/03-advanced/01-modern-architectures/01-transformers.md
  • curriculum/03-AI-ML/03-advanced/01-modern-architectures/02-graph-neural-networks.md
  • curriculum/03-AI-ML/03-advanced/01-modern-architectures/03-reinforcement-learning.md
  • curriculum/03-AI-ML/03-advanced/01-modern-architectures/04-cnn.md
  • curriculum/03-AI-ML/03-advanced/02-research-in-practice/01-paper-replication.md
  • curriculum/03-AI-ML/03-advanced/02-research-in-practice/02-large-model-alignment.md
  • curriculum/03-AI-ML/03-advanced/02-research-in-practice/03-ethics-and-responsibility.md
  • curriculum/04-Protocol Engineering/01-beginner/01-protocol-concepts/01-protocol-vs-application.md
  • curriculum/04-Protocol Engineering/01-beginner/01-protocol-concepts/02-state-machines.md
  • curriculum/04-Protocol Engineering/01-beginner/01-protocol-concepts/03-communication-patterns.md
  • curriculum/04-Protocol Engineering/01-beginner/02-standards/01-specification-writing.md
  • curriculum/04-Protocol Engineering/01-beginner/02-standards/02-versioning-strategies.md
  • curriculum/04-Protocol Engineering/01-beginner/02-standards/03-interoperable-design.md
  • curriculum/04-Protocol Engineering/02-intermediate/01-implementation/01-testing-protocol-compatibility.md
  • curriculum/04-Protocol Engineering/02-intermediate/01-implementation/02-scaling-design.md
  • curriculum/04-Protocol Engineering/02-intermediate/01-implementation/03-resilience-patterns.md
  • curriculum/04-Protocol Engineering/02-intermediate/02-governance-and-ecosystem/01-upgrade-paths.md
  • curriculum/04-Protocol Engineering/02-intermediate/02-governance-and-ecosystem/02-interchain-protocols.md
  • curriculum/04-Protocol Engineering/02-intermediate/02-governance-and-ecosystem/03-community-feedback.md
  • curriculum/04-Protocol Engineering/03-advanced/01-lead-architect/01-optimizing-latency.md
  • curriculum/04-Protocol Engineering/03-advanced/01-lead-architect/02-consensus-economics.md
  • curriculum/04-Protocol Engineering/03-advanced/01-lead-architect/03-security-modeling.md
  • curriculum/04-Protocol Engineering/03-advanced/02-global-adoption/01-regulatory-compliance.md
  • curriculum/04-Protocol Engineering/03-advanced/02-global-adoption/02-performance-auditing.md
  • curriculum/04-Protocol Engineering/03-advanced/02-global-adoption/03-enterprise-integration.md
  • curriculum/05-products/00-personal-operator.md
  • curriculum/05-products/00-value-engine.md
  • curriculum/05-products/01-jarvis.md
  • curriculum/05-products/02-garden.md
  • curriculum/05-products/03-workstream.md
  • curriculum/05-products/04-harnessy.md
  • curriculum/05-products/05-flowledger.md
  • curriculum/05-products/06-economic-incentive-design.md
  • curriculum/05-products/07-security-trust-engineering.md
  • 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
  • curriculum/07-agent-systems/01-what-are-agent-systems.md
  • curriculum/07-agent-systems/02-llm-orchestration.md
  • curriculum/07-agent-systems/03-tool-calling-and-integration.md
  • curriculum/07-agent-systems/04-memory-and-state.md
  • curriculum/07-agent-systems/05-planning-and-reasoning.md
  • curriculum/07-agent-systems/06-safety-and-guardrails.md
  • curriculum/07-agent-systems/07-evaluating-agents.md

Comment on lines +11 to +14
Related_docs:
- 01-beginner/02-standards/02-versioning-strategies
- 02-intermediate/02-governance-and-ecosystem/03-community-feedback
- 02-Blockchain/03-advanced/01-protocol-engineering/03-governance-mechanisms

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
python - <<'PY'
from pathlib import Path

root = Path("curriculum")
for page in root.glob("04-Protocol Engineering/**/*.md"):
    lines = page.read_text().splitlines()
    in_related = False
    for line in lines:
        if line.startswith("Related_docs:"):
            in_related = True
            continue
        if in_related:
            if not line.startswith("  - "):
                in_related = False
                continue
            value = line[4:].strip()
            candidate = root / f"{value}.md"
            print(f"{page}: {value} -> {'OK' if candidate.exists() else 'MISSING'}")
PY

Repository: Flow-Research/learn

Length of output: 9110


🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf "Repository files matching link config/render docs:\n"
git ls-files | rg -i '(^|/)(README|config|_config|generate|build|link|render|navigation|docs)' | head -200

printf "\nReferences to Related_docs:\n"
rg -n "Related_docs|related_docs|related docs|related" . -g '!*.gitignore' | head -200

printf "\nCurriculum README/frontmatter-like files:\n"
for f in README.md curriculum/README.md; do
  if [ -f "$f" ]; then
    echo "--- $f ---"
    fd . --min-depth 2 --max-depth 4 -t f | sed 's#^\./##' | rg '(^|/)Readme|(^|/)readme|config|nav|sitemap|index' | head -50
  fi
done

Repository: Flow-Research/learn

Length of output: 12956


🏁 Script executed:

#!/bin/bash
set -euo pipefail

python3 - <<'PY'
from pathlib import Path
import os, subprocess, subprocess, re

root = Path("curriculum")
files = list(root.glob("04-Protocol Engineering/**/*.md"))
missing = []
nonmissing = []
for page in sorted(files):
    text = page.read_text()
    m = re.search(r'^Related_docs:\s*($|[\s\S]*?)^(?=Related_|^[A-Za-z_].*:|^[A-Za-z]|\Z)', text, flags=re.M)
    if not m:
        continue
    block = (m.group(1) + "\n").splitlines()
    in_related = False
    for line in block:
        if line.startswith("Related_docs:"):
            in_related = True
            continue
        if in_related:
            if line.startswith("  - "):
                value = line[4:].strip()
                candidate = root / f"{value}.md"
                status = "OK" if candidate.exists() else "MISSING"
                (nonmissing if status=="OK" else missing).append((str(page), value, status, candidate))
            if not line.startswith("  - ") and line.strip():
                break
    in_related = False

print(f"Checked {len(files)} files")
print(f"Related_docs entries with existing root/{value}.md candidates: {len(nonmissing)}")
print(f"Related_docs entries MISSING as root/{value}.md: {len(missing)}")
print("\nSample entries:")
all_entries = nonmissing + missing
for row in all_entries[:40] + ([] if len(all_entries) <= 40 else missing[20:]):
    print(" ".join(row))
PY

printf "\nCONTRIBUTING linking guidance around Related_docs:\n"
sed -n '150,220p' CONTRIBUTING.md

printf "\nSample file frontmatter (lines 1-20):\n"
for f in \
  "curriculum/04-Protocol Engineering/02-intermediate/02-governance-and-ecosystem/01-upgrade-paths.md" \
  "curriculum/04-Protocol Engineering/06-rust-engineering/15-observability-performance-deployment.md"
do
  echo "--- $f ---"
  sed -n '1,20p' "$f"
done

Repository: Flow-Research/learn

Length of output: 311


🏁 Script executed:

#!/bin/bash
set -euo pipefail

python3 - <<'PY'
from pathlib import Path
import re

root = Path("curriculum")
files = list(root.glob("04-Protocol Engineering/**/*.md"))
missing = []
nonmissing = []
for page in sorted(files):
    text = page.read_text()
    m = re.search(r'^Related_docs:\s*($|[\s\S]*?)^(?=Related_|^[A-Za-z_].*:|^[A-Za-z]|\Z)', text, flags=re.M)
    if not m:
        continue
    block = (m.group(1) + "\n").splitlines()
    in_related = False
    for line in block:
        if line.startswith("Related_docs:"):
            in_related = True
            continue
        if in_related:
            if line.startswith("  - "):
                value = line[4:].strip()
                candidate = root / f"{value}.md"
                status = "OK" if candidate.exists() else "MISSING"
                (nonmissing if status == "OK" else missing).append((str(page), value, status, str(candidate)))
            if not line.startswith("  - ") and line.strip():
                break
    in_related = False

print(f"Checked {len(files)} files")
print(f"Related_docs entries with existing curriculum/{value}.md candidates: {len(nonmissing)}")
print(f"Related_docs entries MISSING as curriculum/{value}.md: {len(missing)}")
print("\nExamples:")
for row in (nonmissing + missing)[:30]:
    print(" ".join(row))
PY

printf "\nCONTRIBUTING linking guidance around Related_docs:\n"
sed -n '150,220p' CONTRIBUTING.md

printf "\nSample file frontmatter (lines 1-20):\n"
for f in \
  "curriculum/04-Protocol Engineering/02-intermediate/02-governance-and-ecosystem/01-upgrade-paths.md" \
  "curriculum/04-Protocol Engineering/06-rust-engineering/15-observability-performance-deployment.md"
do
  echo "--- $f ---"
  sed -n '1,20p' "$f"
done

Repository: Flow-Research/learn

Length of output: 311


🏁 Script executed:

#!/bin/bash
set -euo pipefail

python3 - <<'PY'
from pathlib import Path
import re

root = Path("curriculum")
files = list(root.glob("04-Protocol Engineering/**/*.md"))
missing = []
nonmissing = []

for page in sorted(files):
    text = page.read_text()
    m = re.search(r'^Related_docs:\s*($|[\s\S]*?)^(?=[A-Za-z_].*:|^[A-Za-z]|\Z)', text, flags=re.M)
    if not m:
        continue
    block = (m.group(1) + "\n").splitlines()
    in_related = False
    entry_value = None
    for line in block:
        if line.startswith("Related_docs:"):
            in_related = True
            continue
        if in_related:
            if line.startswith("  - "):
                entry_value = line[4:].strip()
                candidate = root / f"{entry_value}.md"
                status = "OK" if candidate.exists() else "MISSING"
                (nonmissing if status == "OK" else missing).append((str(page), entry_value, status, str(candidate)))
            if not line.startswith("  - ") and line.strip():
                break

print(f"Checked {len(files)} files")
print(f"Related_docs entries with existing curriculum/{entry_value}.md candidates: {len(nonmissing)}")
print(f"Related_docs entries MISSING as curriculum/{entry_value}.md: {len(missing)}")
print("\nExamples:")
for row in (nonmissing + missing)[:30]:
    print(" ".join(row))
PY

printf "\nCONTRIBUTING linking guidance around Related_docs:\n"
sed -n '150,220p' CONTRIBUTING.md

printf "\nSample file frontmatter (lines 1-20):\n"
for f in \
  "curriculum/04-Protocol Engineering/02-intermediate/02-governance-and-ecosystem/01-upgrade-paths.md" \
  "curriculum/04-Protocol Engineering/06-rust-engineering/15-observability-performance-deployment.md"
do
  echo "--- $f ---"
  sed -n '1,20p' "$f"
done

Repository: Flow-Research/learn

Length of output: 4856


Normalize Related_docs to canonical document paths.

The values are bare relative path fragments (no curriculum/, no .md) and several values do not resolve as curriculum/<value>.md, while the repo guidance uses relative markdown links such as (related-lesson.md). Use the canonical repository paths or Markdown/URL links instead of bare slugs.

📍 Affects 9 files
  • curriculum/04-Protocol Engineering/02-intermediate/02-governance-and-ecosystem/01-upgrade-paths.md#L11-L14 (this comment)
  • curriculum/04-Protocol Engineering/02-intermediate/02-governance-and-ecosystem/02-interchain-protocols.md#L11-L14
  • curriculum/04-Protocol Engineering/02-intermediate/02-governance-and-ecosystem/03-community-feedback.md#L11-L14
  • curriculum/04-Protocol Engineering/03-advanced/01-lead-architect/01-optimizing-latency.md#L11-L14
  • curriculum/04-Protocol Engineering/03-advanced/01-lead-architect/02-consensus-economics.md#L11-L14
  • curriculum/04-Protocol Engineering/03-advanced/01-lead-architect/03-security-modeling.md#L11-L15
  • curriculum/04-Protocol Engineering/03-advanced/02-global-adoption/01-regulatory-compliance.md#L11-L14
  • curriculum/04-Protocol Engineering/03-advanced/02-global-adoption/02-performance-auditing.md#L11-L14
  • curriculum/04-Protocol Engineering/03-advanced/02-global-adoption/03-enterprise-integration.md#L11-L14
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@curriculum/04-Protocol`
Engineering/02-intermediate/02-governance-and-ecosystem/01-upgrade-paths.md
around lines 11 - 14, Normalize the Related_docs entries to valid canonical
repository paths or Markdown/URL links, ensuring every referenced document
resolves and follows the repository’s relative-link convention. Apply this to
curriculum/04-Protocol
Engineering/02-intermediate/02-governance-and-ecosystem/01-upgrade-paths.md:11-14,
curriculum/04-Protocol
Engineering/02-intermediate/02-governance-and-ecosystem/02-interchain-protocols.md:11-14,
curriculum/04-Protocol
Engineering/02-intermediate/02-governance-and-ecosystem/03-community-feedback.md:11-14,
curriculum/04-Protocol
Engineering/03-advanced/01-lead-architect/01-optimizing-latency.md:11-14,
curriculum/04-Protocol
Engineering/03-advanced/01-lead-architect/02-consensus-economics.md:11-14,
curriculum/04-Protocol
Engineering/03-advanced/01-lead-architect/03-security-modeling.md:11-15,
curriculum/04-Protocol
Engineering/03-advanced/02-global-adoption/01-regulatory-compliance.md:11-14,
curriculum/04-Protocol
Engineering/03-advanced/02-global-adoption/02-performance-auditing.md:11-14, and
curriculum/04-Protocol
Engineering/03-advanced/02-global-adoption/03-enterprise-integration.md:11-14;
update each affected Related_docs list rather than retaining bare path
fragments.

Drop the '04-Protocol Engineering' prefix so all Future_Topics
values across the curriculum follow a consistent topic-only naming
convention.

Addresses CodeRabbit review comment on PR Flow-Research#12.
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