菜单
Use this skill whenever you change user-facing or developer-facing documentation in javafxTool. The project ships two documentation sites — docsify (`docs/`) and Doxygen (`doxygen/`) — and three README languages, all of which usually need to be updated together.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Use this skill whenever you author or amend git commits, write a pull request title, or generate suggested commit messages for the javafxTool repository. It enforces the AngularJS Git Commit Message Conventions used by the project.
Use this skill whenever you add, upgrade, downgrade or remove a Maven dependency in javafxTool. The project surfaces its bundled dependencies in several places (UI, IDE artifact descriptors, READMEs) and they all have to stay in sync.
Use this project skill when implementing, testing, or reviewing changes in the javafxTool JavaFX/Maven codebase.
| name | documentation-update |
| description | Use this skill whenever you change user-facing or developer-facing documentation in javafxTool. The project ships two documentation sites — docsify (`docs/`) and Doxygen (`doxygen/`) — and three README languages, all of which usually need to be updated together. |
| license | MIT |
javafxTool ships documentation in three places. A user-visible change usually needs all three updated in the same pull request.
| Surface | Tool | Source | Output |
|---|---|---|---|
| docsify site | docsify 4 | docs/ | https://javafxtool.tlcsdm.com/ |
| API / design site | Doxygen | doxygen/ + Java sources | docs-gen/ (CI publishes) |
| Repo READMEs | Markdown | README.md, README_zh.md, README_jp.md | GitHub repo home |
| Change kind | docsify? | Doxygen? | READMEs? |
|---|---|---|---|
| New SPI contract | ✅ docs/develop/Interface.md | ✅ doxygen/pages/implementation-principles.md + JavaDoc | If end-user-visible |
| New module / app | ✅ new page under docs/<module>/ + sidebar | ✅ doxygen/pages/modules.md + packages.dox | ✅ all three |
| Workflow / process | ✅ docs/develop/Workflow.md | ✅ doxygen/pages/contribution-workflow.md | Maybe |
| Bug fix without UX change | Optional | If JavaDoc affected | ❌ |
| Dependency bump | If listed in README | If listed | ✅ all three |
docs/)docs/_sidebar.md. Add an entry when
you add a page.docs/_navbar.md.# Title).overview/, develop/,
common/, smc/, qe/, …).[link](Interface.md)).```text block — the
bundled docsify build does not load Mermaid.docs/overview/Into.md, docs/develop/Note.md).doxygen/)doxygen/Doxyfile. The INPUT
list controls what is parsed; EXCLUDE_PATTERNS filters tests and generated
artifacts.doxygen/pages/.doxygen/pages/<name>.md starting with
# Title {#anchor-name}.doxygen/pages/related-pages.md
with - @subpage <anchor-name>.@dot … @enddot blocks. Follow the
styling already used in doxygen/pages/modules.md and
doxygen/pages/implementation-principles.md (rounded boxes, transparent
background, the existing color palette)./** ... */); JAVADOC_AUTOBRIEF
is enabled, so the first sentence becomes the brief description.From the repository root:
doxygen doxygen/Doxyfile
Output is written to docs-gen/ and is git-ignored.
When you change anything user-visible (features, screenshots, dependencies, build steps, supported platforms), update all three language files in the same commit so they don't drift:
README.md — EnglishREADME_zh.md — Simplified ChineseREADME_jp.md — JapaneseIf you don't speak one of the languages, mirror the structure of the change
exactly and leave a TODO(translate) marker only as a last resort.
python3 -m http.server -d docs 3000) and verify the new page
renders and is linked from the sidebar.doxygen doxygen/Doxyfile and check the warning log near the
end of the output for unresolved references or missing files.Use the docs type from the
commit-conventions skill, e.g.
docs(doxygen): add contribution workflow page.