Skip to content
Skills Library
Documents & office · Writing

sync-docs-site

/sync-docs-site

Bring the user documentation in docs-site/ up to date with Folio's released features, from CHANGELOG.md, the README and the code. Use when the user asks to update, sync or check the docs site, after a release, or when a feature change should be reflected in the user docs.

Repository
folio ↗
Licence
MIT
Last repository change
13.11.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
1
Scripts
0
HTML comments
2
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 13.11.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What to check before installing
  • SKILL.md zawiera komentarze HTML (2). Nie widać ich w podglądzie Markdown, a model je czyta.

What it does and when to use it

Bring the user documentation in docs-site/ up to date with Folio's released features, from CHANGELOG.md, the README and the code. Use when the user asks to update, sync or check the docs site, after a release, or when a feature change should be reflected in the user docs.

Original author description

Bring the user documentation in docs-site/ up to date with Folio's released features, from CHANGELOG.md, the README and the code. Use when the user asks to update, sync or check the docs site, after a release, or when a feature change should be reflected in the user docs.

How it works

  1. 1. Find what changed
  2. 2. Check every fact against the code
  3. 3. Write
  4. 4. Check
  5. 5. Branch and commit
Original SKILL.md headings · 65 lines, 432 words
SKILL.md preview
---
name: sync-docs-site
description: Bring the user documentation in docs-site/ up to date with Folio's released features, from CHANGELOG.md, the README and the code. Use when the user asks to update, sync or check the docs site, after a release, or when a feature change should be reflected in the user docs.
---

# Sync the docs site with the latest features

`docs-site/` is the user documentation (VitePress), published at
`crazzybot.github.io/folio/docs/`. It describes the **latest release**, not
`main`: features under `## [Unreleased]` in `CHANGELOG.md` aren't documented
yet, unless the user is preparing that release.

## 1. Find what changed

- `docs-site/README.md` records "Synced with" a version. Read the
  `CHANGELOG.md` sections after that version up to the latest release.
- List each user-visible change: new features, renamed UI, new or changed
  shortcuts and menu items, changed defaults, removed features.
- Map each one to the page it belongs on (the sidebar in
  `docs-site/.vitepress/config.mts` lists them). A feature with no fitting
  page may need a new one; propose it to the user before creating it.
- Also check the open `<!-- TODO … -->` comments in `docs-site/`: a release
  may now answer one.

## 2. Check every fact against the code

The CHANGELOG and README say what was meant; the code says what shipped.
Before writing a claim, confirm it:

- Menu items and shortcuts: the menu template in `desktop/src/main.ts`
  (`accelerator:`). Keep `reference/shortcuts.md` in step with it.
- UI names: the labels and `aria-label`s in `frontend/src/components/`.
  Write UI names in **bold**, exactly as the app shows them.
- Settings: `desktop/src/settings.ts`.
- Front matter and Markdown support: `packages/core/src/` and the frontend's
  remark/rehype plugins.

When the code and the CHANGELOG disagree, follow the code and tell the user.

## 3. Write

- Match the existing pages: short sentences, task-oriented headings, macOS
  shortcut first (`⌘F` / `Ctrl+F`), **bold** UI names, no marketing tone.
- Update existing pages before adding new ones. Keep page paths stable: the
  Help menu, the demo banner and outside links point at them. If a page must
  move, keep the old path working or tell the user.
- A gap you can't fill from the code or the CHANGELOG gets an
  `<!-- TODO: … -->` comment rather than a guess.
- Pro features (once they exist) get a **Pro** badge; don't document them
  before the release that ships them.
- Removed features: delete their docs, and check the FAQ.

## 4. Check

```bash
cd docs-site && npm run build
```

- The build must pass; VitePress fails on dead internal links.
- Preview (`npm run dev`) the pages you changed, in light and dark and at
  375px width.
- Update "Synced with" in `docs-site/README.md` to the release you synced to.

## 5. Branch and commit

Work on a branch from `main`: `docs/sync-docs-<version>`. Commit only when
the user asks, as `docs(docs-site): sync with X.Y.Z`. Summarise for the user
what changed, page by page, and the TODOs left.

Versions

The database has no other skills named sync-docs-site.

Database snapshot: 13.11.2026 · package version 23b0ee69c876 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 1 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100docs
    Sync docs with code. Updates README, CLAUDE.md or AGENTS.md, docs/, API docs, changelog, ADRs, env examples and agent memory after a change; a drift-check mode reports mismatches without editing. Use when docs are stale, update the docs, sync README, docs out of date, after…
  • 95docs-manager
    Documentation management workflow for MkDocs sites and standalone markdown files — initialize, generate, update docs, and create change summaries. Use when asked to "create docs", "write README", "update documentation", "generate docs site", "write CONTRIBUTING", "manage…
  • 100docs-updater
    Provides automated documentation updates by analyzing git changes between the current branch and the last release tag. Performs git diff analysis to identify modifications, then updates README.md, CHANGELOG.md following Keep a Changelog standard, and discovers documentation…
  • 95docs-manager
    Documentation management workflow for MkDocs sites and standalone markdown files -- initialize, generate, update docs, and create change summaries. Use when asked to "create docs", "write README", "update documentation", "generate docs site", "write CONTRIBUTING", "manage…
  • 100nf-core-pipeline-docs
    Keep nf-core pipeline documentation in sync with the code: README, docs/usage.md, docs/output.md, CITATIONS.md, CHANGELOG.md, and the automated MultiQC methods description text. Use whenever pipeline behaviour, parameters, outputs, or tool set change.
  • 85write-the-docs
    Write or edit project documentation. Use when writing a README, design doc, or module doc.

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.