Skip to content

docs: Curriculo fork overview + zola graph design - #4

Merged
devrishik merged 1 commit into
masterfrom
docs/curriculo-graph
Aug 11, 2026
Merged

devrishik merged 1 commit into
masterfrom
docs/curriculo-graph

Conversation

@devrishik

@devrishik devrishik commented Aug 11, 2026

Copy link
Copy Markdown

Summary

  • Add CURRICULO.md — fork overview, release pins, commands, secrets, operator loop.
  • Add docs/curriculo/graph.md — living design (Firecrawl once, files-as-truth markdown, clean extraction, Shortcode for Streamable videos getzola/zola#79 build bar, GH Actions shape).
  • Update README.md + cli-usage.md to document translate and graph.

Source: workspace docs/superpowers/specs/2026-08-11-zola-graph-design.md (now points here as canonical).

Test plan

  • Links from README / cli-usage resolve in the GitHub UI
  • No code/behavior change

Made with Cursor

Summary by CodeRabbit

  • Documentation
    • Added comprehensive documentation for the Curriculo Zola fork and release tags.
    • Documented zola translate and zola graph migrate|refresh commands, including usage, outputs, and API-key requirements.
    • Described knowledge graph migration, local refresh and build workflows, generated artifacts, failure handling, and deployment procedures.
    • Clarified that external crawling is used only during migration; builds and refreshes use local content.

Land the approved graph design as living docs in the fork (CURRICULO.md,
docs/curriculo/graph.md), point README + cli-usage at translate/graph, and
record the operator loop (migrate once → refresh forever → pages.dev).
@devrishik
devrishik merged commit 88d6ce5 into master Aug 11, 2026
@devrishik
devrishik deleted the docs/curriculo-graph branch August 11, 2026 11:08
@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 112d3b0e-8f42-427e-a93a-62ad70963fcd

📥 Commits

Reviewing files that changed from the base of the PR and between 9032319 and aff98ea.

📒 Files selected for processing (4)
  • CURRICULO.md
  • README.md
  • docs/content/documentation/getting-started/cli-usage.md
  • docs/curriculo/graph.md

Walkthrough

The PR adds documentation for Curriculo-specific commands, graph migration and refresh behavior, generated artifacts, API keys, build gates, deployment workflows, and Rust module responsibilities.

Changes

Curriculo documentation

Layer / File(s) Summary
CLI command documentation
CURRICULO.md, README.md, docs/content/documentation/getting-started/cli-usage.md
Documents release pins, zola translate, and zola graph migrate|refresh, including options, API keys, and generated outputs.
Graph processing and artifacts
docs/curriculo/graph.md
Documents migration and refresh processing, local source-of-truth rules, graph JSON artifacts, partial failures, build gates, and implementation modules.
Operations and deployment workflow
CURRICULO.md, docs/curriculo/graph.md
Documents migration, local refresh, Pages deployment, CI responsibilities, cutover sequencing, required secrets, and design references.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

Poem

I hop through docs where new commands gleam,
Graphs migrate once, then refresh from the stream.
Local pages build, with secrets tucked away,
CI checks the path for each deployment day.
Binky! Curriculo’s map is clear and bright.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/curriculo-graph

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