WooCommerce Markdown Guidelines
woocommerce/woocommerce
Rules for writing and editing markdown in the WooCommerce repository, with the project's markdownlint settings for headings, lists and code blocks.
A skill your agent uses when writing or reviewing Flet documentation, including Python docstrings (Google style, reST roles, admonitions), Markdown docs (cross-references, images, code examples)…
Install Docs Conventions
$ npx skills add flet-dev/flet --skill docs-conventions -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install flet-dev/flet docs-conventions --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/flet-dev/flet.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/docs-conventions .claude/skills/docs-conventions && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "docs-conventions" agent skill from https://github.com/flet-dev/flet/tree/main/.agents/skills/docs-conventions into .claude/skills/docs-conventions/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs-conventions", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/flet-dev/flet/tree/main/.agents/skills/docs-conventionsType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add flet-dev/flet --skill docs-conventions -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install flet-dev/flet docs-conventions --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/flet-dev/flet.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/docs-conventions .agents/skills/docs-conventions && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "docs-conventions" agent skill from https://github.com/flet-dev/flet/tree/main/.agents/skills/docs-conventions into .agents/skills/docs-conventions/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs-conventions", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add flet-dev/flet --skill docs-conventions -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install flet-dev/flet docs-conventions --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/flet-dev/flet.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/docs-conventions .cursor/skills/docs-conventions && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "docs-conventions" agent skill from https://github.com/flet-dev/flet/tree/main/.agents/skills/docs-conventions into .cursor/skills/docs-conventions/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs-conventions", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/flet-dev/flet.git --path .agents/skills/docs-conventions--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add flet-dev/flet --skill docs-conventions -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install flet-dev/flet docs-conventions --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/flet-dev/flet.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/docs-conventions .gemini/skills/docs-conventions && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "docs-conventions" agent skill from https://github.com/flet-dev/flet/tree/main/.agents/skills/docs-conventions into .gemini/skills/docs-conventions/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs-conventions", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install flet-dev/flet docs-conventionsInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add flet-dev/flet --skill docs-conventions -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/flet-dev/flet.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/docs-conventions .github/skills/docs-conventions && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "docs-conventions" agent skill from https://github.com/flet-dev/flet/tree/main/.agents/skills/docs-conventions into .github/skills/docs-conventions/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs-conventions", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add flet-dev/flet --skill docs-conventions -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install flet-dev/flet docs-conventions --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/flet-dev/flet.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/docs-conventions .opencode/skills/docs-conventions && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "docs-conventions" agent skill from https://github.com/flet-dev/flet/tree/main/.agents/skills/docs-conventions into .opencode/skills/docs-conventions/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "docs-conventions", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
docs-conventions- GitHub stars
- 17k
- Token cost
- ~1.6k tokens
- SKILL.md length
- 512 words
- Files
- 1
- Skills in repo
- 14
- Repo updated
- First seen
- Licence
- Apache-2.0
At a glance
A skill your agent uses when writing or reviewing Flet documentation, including Python docstrings (Google style, reST roles, admonitions), Markdown docs (cross-references, images, code examples)…
- Reviewing Flet documentation
- SKILL.md covers Python Docstrings, Cross-references, Admonitions in docstrings and Admonitions, plus 5 more sections
- Calls yarn
- Including Python docstrings (Google style
What it does
Docs Conventions is an agent skill from flet-dev/flet. Use when writing or reviewing Flet documentation, including Python docstrings (Google style, reST roles, admonitions), Markdown docs (cross-references, images, code examples), and sidebar navigation.
Its SKILL.md is about 1.6k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Development, covering Technical documentation and Markdown. It works with Python. The repository describes itself as: Build realtime web, mobile and desktop apps in Python only. No frontend experience required. The licence is Apache-2.0.
When your agent uses it
- Reviewing Flet documentation
- Including Python docstrings (Google style
- Markdown docs (cross-references
- Sidebar navigation
Example prompts
- “/docs-conventions”
Requirements
- Python 3
What it can do on your machine
Read from SKILL.md and the folder at commit 9748de3. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
Shell commands in SKILL.md call:
yarn
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md. Its commands use yarn, which can reach the network depending on how they are called.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Docs Conventions loads about 1.6k tokens when it runs. Until then it costs about 54 tokens; SKILL.md has 512 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from flet-dev/flet at commit 9748de3, republished under its Apache-2.0 licence (© flet-dev). 512 words, ~1,598 tokens.
Download SKILL.mdSave it as
.claude/skills/docs-conventions/SKILL.md (or your agent's skills folder).- name
- docs-conventions
- description
- Use when writing or reviewing Flet documentation, including Python docstrings (Google style, reST roles, admonitions), Markdown docs (cross-references, images, code examples), and sidebar navigation.
Documentation Conventions
Docs live in website/docs/. Docusaurus renders them as the website.
Python Docstrings
Use Google style docstrings with sections: Args:, Returns:, Raises:, Note:, Example:, Warning:.
Cross-references
reST roles
Prefer these in Python docstrings. CrocoDocs renders them as links in the API docs and they keep authoring terse when the auto-derived label is acceptable.
Supported roles: :class:, :attr:, :meth:, :func:, :data:, :mod:
"""
If a parent is a :class:`~flet.ResponsiveRow`, this property determines
how many virtual columns the control spans.
See :attr:`value` or :attr:`flet.Text.size` for the current selection.
Calls :meth:`flet.Page.update` after modifying controls.
"""Rules:
- Qualified reference:
:attr:flet.Page.route`` — links to the member, displays inline codePage.route - Extension reference:
:attr:flet_map.Map.animation_curve`` — links to the extension member, displays inline codeMap.animation_curve - Short display with
~::attr:~flet.Page.route`` — links to the member, displays inline coderoute - Local member (same class):
:attr:value`` — no qualifier needed - Method with parens:
:meth:update`` — do NOT include()in the target
For plain class references like :class:flet.Page and extension references like `:class:`flet_map.Map, the website strips leading public package aliases automatically,
so they display as inline code Page and Map.
Not supported:
- Custom labels like
:class:my label <flet.Page>`` — the label is always auto-derived from the target - Roles for symbols not in CrocoDocs API data degrade to inline code
Xrefs
Reference-style Markdown links of the form [label][key], where key is the
fully-qualified dotted symbol path (same form as reST role targets).
Use as the default form for linking to API symbols from Markdown docs
(.md / .mdx).
Examples:
Class: [`Page`][flet.Page]
Attribute: [`route`][flet.Page.route]
Method: [`Page.update()`][flet.Page.update]
Extension: [`Video.controls`][flet_video.Video.controls]
Plain text: [the route attribute][flet.Page.route]When to prefer over the other forms:
- Flexible labels — the first
[ ]accepts any text or inline code, unlike reST roles whose label is always auto-derived from the target - Path-independent — keys are dotted symbol paths, so links don't break when source files are moved, renamed, or restructured (unlike Markdown link paths with
../and#flet.X.yanchors) - Terser than Markdown links to the same symbol — no relative path or anchor to maintain
- Greppable — searching for the dotted key finds every reference to that symbol across all docs
Rules:
- The label (inside the first
[ ]) is the rendered text — inline code or plain text - The key (inside the second
[ ]) is the fully-qualified dotted path; do NOT include()for methods - Unresolved keys render as broken reference-style links (silent fallback) — verify with a build or
yarn crocodocs:generate
Show full SKILL.md (172 more words)Show less
Markdown links
Fallback for cases xrefs cannot cover:
- docs-only Python strings — the
docs_reasonparameter of@deprecated, extracted validation messages, or short admonition text - links to non-API content (other doc pages, external URLs, anchors that aren't API symbols)
- when the xref entry is missing and you need a working link before regenerating
Use relative .md paths with dot-format anchors.
Examples:
Control: [`Page`](../controls/page.md)
Type: [`DragTargetEvent.global_position`](../types/dragtargetevent.md#flet.DragTargetEvent.global_position)
Plain text: [route](../controls/page.md#flet.Page.route)
Method: [`Page.update()`](../controls/page.md#flet.Page.update)Admonitions in docstrings
Google-style section headers render as Docusaurus admonitions:
"""
Note:
Has effect only if the direct parent is a :class:`~flet.Column`.
Warning:
This property is deprecated. Use :attr:`new_prop` instead.
Example:
Setting up a basic layout:
``ft.Column(controls=[ft.Text("Hello")])``
"""Supported kinds: Note, Warning, Danger, Tip, Info.
Unsupported kinds (e.g. Limitation, Example) are normalized to note.
Empty admonitions are skipped.
Admonitions
:::note
Basic note without title.
:::
:::warning[Important]
Warning with a custom title.
:::Supported types: note, info, tip, warning, danger.
Front matter
---
class_name: "flet.Container"
examples: "controls/container"
example_images: "test-images/examples/material/golden/macos/container"
example_media: "examples/controls/container/media"
title: "Container"
---examples— root-relative path undersdk/python/examples/example_images/example_media— root-relative underwebsite/static/docs/
Images
Use the CrocoDocs Image component. Paths without ../ are resolved against /docs/:
import {Image} from '@site/src/components/crocodocs';
<Image src={frontMatter.example_images + '/image_for_docs.png'} width="55%" />For absolute paths (one-off assets in static/):
<Image src="/docs/assets/controls/charts/bar-chart-diagram.svg" width="65%" />Code examples
import {CodeExample} from '@site/src/components/crocodocs';
<CodeExample path={frontMatter.examples + '/example_1.py'} />Paths are relative to the configured examples_root (sdk/python/examples/).
Inline HTML
Use <kbd>...</kbd> in Python docstrings for keyboard keys, for example
<kbd>Enter</kbd> or <kbd>Shift</kbd>. CrocoDocs preserves this tag in API
docs.
Sidebar Navigation
Edit website/sidebars.yml to change navigation structure:
docs:
Getting started:
- getting-started/installation.md
Controls:
_generated_index:
title: Controls
slug: /controls
description: Browse the complete catalog of controls.
AlertDialog: controls/alertdialog.mdAfter editing, regenerate sidebars.js:
cd website && yarn crocodocs:generate© flet-dev, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in .agents/skills/docs-conventions of flet-dev/flet.
Open the folder on GitHubat commit 9748de3
Compare with similar skills
Docs Conventions next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Docs Conventions this skillflet-dev/flet | 17k | — | ~1.6k | Automated safety check: Pass | Apache-2.0 | |
| WooCommerce Markdown Guidelineswoocommerce/woocommerce | 11k | 1 repos | ~1.7k | Automated safety check: Pass | Custom licence | |
| Flowmark Markdown Formatterjlevy/repren | 374 | — | ~631 | Automated safety check: Pass | MIT | |
| Article Exporteractionbook/actionbook | 1.6k | — | ~3.1k | Automated safety check: Pass | Apache-2.0 | |
| Markdown Without Hard Wrapsprisma/orm | 48k | — | ~472 | Automated safety check: Pass | Apache-2.0 | |
| Open Source Project Articledigoal/blog | 8.6k | — | ~1.3k | Automated safety check: Pass | GPL-2.0 |
Similar skills
Flowmark Markdown Formatter
jlevy/repren
Formats Markdown with the Flowmark auto-formatter for typographic cleanup and semantic line breaks, and helps adopt it across a repository.
Article Exporter
actionbook/actionbook
Export any web article to a local Obsidian-ready Markdown directory.
- Official
Markdown Without Hard Wraps
prisma/orm
Keeps Markdown prose on one line per paragraph instead of wrapping at a fixed column, so renderers can reflow it and diffs stay clean.
Open Source Project Article
digoal/blog
Analyze an open-source project from a repository URL and write a deeply sourced Chinese Markdown article.
GitHub Weekly Trending
digoal/blog
解读用户粘贴的 GitHub 每周 Trending 或开源项目榜单内容，基于用户提供的候选项目、项目 README、GitHub 项目页和 DeepWiki 生成适合公众号发布的 Markdown 文章，并输出到当前项目 markdown 目录。用于 GitHub 周榜解读、每周开源热点、热门开源项目分析、公众号开源项目推荐。
More from flet-dev/flet
All 14 skills in this repoCreate Flet Control Integration Tests
flet-dev/flet
A skill your agent uses when asked to create or update integration tests for any Flet control in sdk/python/packages/flet/integrationtests, including visual goldens and interactive behavior tests.
Create Flet Example Projects
flet-dev/flet
A skill your agent uses when asked to create Flet example projects from flat .py files with main.py and pyproject.toml metadata for Gallery/MCP indexing.
Docs Build And Verify
flet-dev/flet
A skill your agent uses when asked to build, preview, or verify the Flet documentation website, including checking for broken links, broken images, and unresolved reST cross-references.
Flet Deprecation
flet-dev/flet
A skill your agent uses when adding or changing deprecations for Python controls/APIs in sdk/python/packages/, including V.deprecated fields, deprecated decorators, version lifecycle, and docs…
Flet Release Announcement
flet-dev/flet
Create or update a Flet release announcement blog post from changelog notes, matching existing /blog style.
Flet Validation
flet-dev/flet
A skill your agent uses whenever editing validation for Python controls in sdk/python/packages/: adding/changing constrained properties, Raises: ValueError docstrings, beforeupdate() checks, raise…
Related
Works with
Categories
Questions about Docs Conventions
What does Docs Conventions do?
A skill your agent uses when writing or reviewing Flet documentation, including Python docstrings (Google style, reST roles, admonitions), Markdown docs (cross-references, images, code examples)…. Docs Conventions is an agent skill from flet-dev/flet. Use when writing or reviewing Flet documentation, including Python docstrings (Google style, reST roles, admonitions), Markdown docs (cross-references, images, code examples), and sidebar navigation.
When should I use Docs Conventions?
Docs Conventions fits situations like: reviewing Flet documentation; including Python docstrings (Google style; markdown docs (cross-references; sidebar navigation.
How do I install Docs Conventions in Claude Code?
Run `npx skills add flet-dev/flet --skill docs-conventions -a claude-code`. Or copy the skill folder (.agents/skills/docs-conventions in flet-dev/flet) into .claude/skills/docs-conventions in your project. Claude Code loads it when a task matches its description.
How do I install Docs Conventions in Codex?
Run `npx skills add flet-dev/flet --skill docs-conventions -a codex`. Or copy the skill folder (.agents/skills/docs-conventions in flet-dev/flet) into .agents/skills/docs-conventions in your project. Codex loads it when a task matches its description.
Can I use Docs Conventions in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add flet-dev/flet --skill docs-conventions -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-conventions, .gemini/skills/docs-conventions, .github/skills/docs-conventions and .opencode/skills/docs-conventions in your project.
What does Docs Conventions need to run?
Going by SKILL.md and its folder, Docs Conventions needs the command-line tools its instructions call (yarn). Our summary lists: Python 3.
Does Docs Conventions access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Docs Conventions safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Docs Conventions use?
Docs Conventions is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Docs Conventions use?
About 1.6k tokens (SKILL.md is roughly 6.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Docs Conventions?
Skills that share tags, products or a category with Docs Conventions: WooCommerce Markdown Guidelines (woocommerce/woocommerce, 11k stars), Flowmark Markdown Formatter (jlevy/repren, 374 stars), Article Exporter (actionbook/actionbook, 1.6k stars) and Markdown Without Hard Wraps (prisma/orm, 48k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Docs Conventions?
flet-dev (a GitHub organization) maintains it in flet-dev/flet, which has 17,265 GitHub stars. The repository holds 14 skills in this directory. The repository was last updated on October 7, 2026.
Source: flet-dev/flet on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.