Folo knowledge curator
Turn recent Folo items into durable documentation changes for this Mintlify knowledge base. Prefer small, high-confidence updates over broad rewrites.
Required companion skill
Use the repo-local folo skill at .agents/skills/folo/SKILL.md for CLI commands and Folo error handling. Do not duplicate its full command reference in context; read it when Folo command details are needed.
Workflow
- Inspect repo state with
git status --short --branch. - Pull candidate items from Folo:
- start with
npx --yes folocli@latest timeline --limit 50 --format json - use
unread countandunread listonly when unread prioritization is useful - summarize candidates with
jqrather than reading large JSON blobs into the answer
- start with
- Select durable topics using the criteria below.
- Read full source content for shortlisted entries with
entry getandentry read. - Verify with primary or official sources when the claim is recent, high-stakes, product-specific, legal, pricing-related, model-specific, or likely to change.
- Decide whether to update an existing page or add a new page.
- Edit Markdown/MDX and Mintlify navigation.
- Run
npm run validateandnpm run lint; if default Node is unsupported, use an available LTS runtime such asmise x node@22 -- npm run validateandmise x node@22 -- npm run lint. - Commit only the relevant changes and push to the current branch unless the user asked for no push.
Selection criteria
Promote an item into docs when it has lasting reference value for Chinese readers learning software, development, CS, tooling, or technical workflows.
Good candidates:
- stable workflows or checklists
- tool capabilities that change how a developer works
- protocol, API, architecture, or deployment patterns
- postmortems with reusable engineering lessons
- durable comparisons between approaches
- course-relevant or CS fundamentals material
Usually reject:
- short-lived launch hype
- pricing chatter without stable workflow impact
- social commentary without technical takeaway
- unverified model benchmark claims
- rumors or pre-announcement screenshots
- narrow personal updates
If nothing qualifies, report the strongest candidates and why they were not worth landing.
Placement rules
Prefer updating existing pages when the topic naturally fits. Create a new page only when the topic has independent reference value and would be awkward inside an existing note.
Common destinations:
apps/andzh/apps/for user-facing toolsenv/andzh/env/for development environment, deployment, agent workflows, and documentation operationsbackend/,frontend/,software/, oralgo/for domain-specific technical materialabout/courses/andzh/about/courses/for course-style notes
Bilingual sync rule
Every documentation change must update both languages. This site has English (root-level paths) and Chinese (zh/ paths) pages. When you edit or add any English page, you must also edit or add the corresponding zh/ page with equivalent Chinese content. Conversely, any Chinese-only change must be mirrored to the English root page.
Exceptions:
- Course note pages (
about/courses/) are Chinese-only by nature — no English mirror needed. - If the English page already exists but the Chinese mirror is just a stub with a language note pointing to the English version, updating the English page alone is acceptable only if the Chinese stub remains functional and its language-note link still works.
When both pages have full prose content, both must be updated in the same commit. Do not push an update to one language and leave the other stale.
For a Chinese-first source, make the Chinese page the more natural version and keep the English page concise but complete. For an English-first source, make the English page the primary version and keep the Chinese page equivalent in meaning.
When adding a page:
- add frontmatter with
title,description, andicon - add it to
docs.jsonin both language navigation trees when applicable - add a card to the relevant section index if that index uses cards
- keep local links working and prefer local links for internal references
Writing rules
- Preserve the original technical meaning.
- Write concise, practical headings in sentence case.
- Use active voice and direct instructions.
- Bold UI labels when referencing interface text.
- Use code formatting for commands, paths, file names, and identifiers.
- Cite original Folo article URLs or official sources in a
Referencessection. - Separate durable lessons from time-sensitive facts.
- Avoid turning one source into a long paraphrase; synthesize across sources when possible.
Source handling
Use Folo as the intake channel, not as the only authority.
For each landed topic, keep enough provenance to answer:
- Which Folo item triggered this?
- What original URL supports it?
- Did a primary/official source confirm the durable claim?
Do not cite RSS summaries as the sole source when the original article or official documentation is available.
Git and push policy
Before editing, check for unrelated local changes and avoid touching them. After editing, inspect git diff --stat and git diff for the files you changed.
Commit message style:
Add <topic> notesUpdate <existing topic> guideCapture <workflow> pattern
Push with git push origin <current-branch>. If rejected because the remote moved, run git pull --rebase origin <current-branch>, resolve conflicts carefully, rerun validation if content or config changed, then push again.
Final response
Report:
- what Folo items were promoted or rejected
- files changed
- validation results
- commit SHA and push target, if pushed
Keep the response concise. Mention blockers such as Folo auth failure, missing primary-source verification, unsupported Node version, validation failure, or push rejection.
Source: markbang/documentation — distributed by TomeVault.