docs: expand Curriculo fork section in README - #6
Conversation
The banner only named the two subcommands. Give the fork a self-contained section: a command table (translate / graph migrate-once / graph refresh), the migrate-only-Firecrawl rule, the operator loop, secrets, the release-pin convention, and the PRs-not-issues workflow — so the README stands on its own before linking to CURRICULO.md / graph.md / the CLI reference. Co-authored-by: Cursor <cursoragent@cursor.com>
WalkthroughThe README replaces a brief Curriculo fork note with detailed documentation for translation and graph commands, network behavior, Firecrawl restrictions, CLI usage, required secrets, pinned releases, and related documentation. ChangesCurriculo README documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 `@README.md`:
- Line 20: Update the description for `zola graph migrate` in the README table
by replacing “Firecrawl-crawl” with “Crawl a live site with Firecrawl,” while
preserving the rest of the entry unchanged.
- Line 19: Update the README translation command entry to describe generated
files generically as co-located <slug>.<lang>.md siblings, or explicitly clarify
that index applies only to index pages; remove the unconditional index.<lang>.md
wording.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
|
|
||
| | Command | What it does | Network | | ||
| |---|---|---| | ||
| | `zola translate [--max N] [--dry-run]` | Generate/refresh co-located `index.<lang>.md` siblings via OpenRouter, hash-gated on `extra.source_hash`. | OpenRouter | |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Document the translation output path generically.
The CLI contract describes co-located <slug>.<lang>.md siblings, but this line hard-codes index.<lang>.md. For pages with another slug, operators may look for the wrong file. Use <slug>.<lang>.md, or state when index applies.
Proposed wording
-| `zola translate [--max N] [--dry-run]` | Generate/refresh co-located `index.<lang>.md` siblings via OpenRouter, hash-gated on `extra.source_hash`. | OpenRouter |
+| `zola translate [--max N] [--dry-run]` | Generate/refresh co-located `<slug>.<lang>.md` siblings via OpenRouter, hash-gated on `extra.source_hash`. | OpenRouter |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | `zola translate [--max N] [--dry-run]` | Generate/refresh co-located `index.<lang>.md` siblings via OpenRouter, hash-gated on `extra.source_hash`. | OpenRouter | | |
| | `zola translate [--max N] [--dry-run]` | Generate/refresh co-located `<slug>.<lang>.md` siblings via OpenRouter, hash-gated on `extra.source_hash`. | OpenRouter | |
🤖 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 `@README.md` at line 19, Update the README translation command entry to
describe generated files generically as co-located <slug>.<lang>.md siblings, or
explicitly clarify that index applies only to index pages; remove the
unconditional index.<lang>.md wording.
| | Command | What it does | Network | | ||
| |---|---|---| | ||
| | `zola translate [--max N] [--dry-run]` | Generate/refresh co-located `index.<lang>.md` siblings via OpenRouter, hash-gated on `extra.source_hash`. | OpenRouter | | ||
| | `zola graph migrate --from <url> [--max N] [--force] [--dry-run]` | **Once per origin.** Firecrawl-crawl a live site into markdown + a topical KG under `data/graph/`. Guarded by `meta.source_origin`. | Firecrawl + OpenRouter | |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Replace the “Firecrawl-crawl” wording.
Use “Crawl a live site with Firecrawl” to keep the action and service name distinct.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~20-~20: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...gin.** Firecrawl-crawl a live site into markdown + a topical KG under data/graph/. Gua...
(MARKDOWN_NNP)
🤖 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 `@README.md` at line 20, Update the description for `zola graph migrate` in the
README table by replacing “Firecrawl-crawl” with “Crawl a live site with
Firecrawl,” while preserving the rest of the entry unchanged.
Source: Linters/SAST tools
1 participant
Summary
section: a command table (
translate,graph migrateonce,graph refreshforever), the Firecrawl-is-migrate-only rule, the operator loop, secrets, the
v0.23.2-curriculo.Nrelease-pin convention, and the PRs-not-issues workflow.to resolve.
Pairs with landing-website getzola#97 (CLAUDE.md "how to work with Zola").
Test plan
commands, the migrate-once/refresh-forever loop, and how releases are
pinned without opening another file?
Made with Cursor
Summary by CodeRabbit
translate,graph migrate, andgraph refreshcommands, including usage examples and network behavior.