docs: add Learn section outline plan (#519)#520
Conversation
Add plans/learn-section-outline/ — an agentic-first plan for building out the Learn track: - Reconciles the original Confluence outline against current learn/ content (3 guides already shipped: using-agents, harper-applications-in-depth, and the full caching series) and flags the inverted Custom Resources dependency. - Maps legacy /docs/ paths to current /reference/ sources, with the legacy tree recoverable at git ref 0f754c5. - Phase 1: create-issues.sh generates 20 [Learn] tracking issues (label `content`, type `Feature`) from per-guide body files in issues/. - Phase 2: a per-guide generation workflow — worktree/branch, draft from the guide template + reference sources, local /review pass, build check, one PR per guide with @HarperFast/developers requested as reviewer. Closes #519 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-520 This preview will update automatically when you push new commits. |
kriszyp
left a comment
kriszyp
left a comment
There was a problem hiding this comment.
This looks good. I assume this is kind intended to be more carefully describing the content directly in front of us. And the later sections are things that will be filled out more as we get them in the next few... months? years?
For example, I don't even know what "compaction" means for us. RocksDB does it automatically (I vaguely remember some other storage engine we used to use).
|
Yeah this outline is honestly just catch-up. I had a confluence page from before the reference migration work that outlined a number of guides we should have. Basically things that had existed in the old That outline stagnated for months now, so this is an attempt at at least bringing some of it forward. |
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-520 This preview will update automatically when you push new commits. |
That's great. Its a work in progress, which makes perfect sense. It's a solid direction. I still approve! |
🧹 Preview CleanupThe preview deployment for this PR has been removed. |
3 participants
Closes #519.
Adds
plans/learn-section-outline/— a repo-contributed, agentic-first plan for building out the Learn track, so the outline lives in-repo for review and longevity.What's here
README.md— the plan: background, current-state reconciliation, the/docs/→/reference/path mapping, guide inventory + ordering, conventions, and a two-phase execution flow.create-issues.sh— Phase 1: creates 20[Learn]tracking issues from the body files inissues/(labelcontent, typeFeature). Supports dry-run (default) and--create.issues/*.md— one body file per guide, used verbatim as each issue body.Key findings baked into the plan
using-agents(AI best practices),harper-applications-in-depth(key app features), and the full caching series (Caching Pt. 1 + all its planned follow-ons)./docs/→/reference/per the issue; the deleted legacy tree is recoverable at git ref0f754c5ffor narrative framing.Phase 2 (described, not executed here)
Per-guide generation workflow: worktree/branch off
main→ draft fromlearn/_guide-template.mdx+ reference sources → local/reviewpass →docusaurus buildcheck → one PR per guide with@HarperFast/developersrequested as reviewer.Nothing in
plans/is part of the published docs build (Docusaurus only scanslearn/,reference/,fabric/,release-notes/).sent with Claude Opus 4.8