eisland-dev-update-docs

Solid

Update or create documentation in the eIsland VuePress docs site (web/eisland-web-docs). Use this skill whenever the user asks to update docs, add documentation, write a doc article, document a feature, update the tech stack docs, update plugin docs, update command docs, or any task involving files under web/eisland-web-docs/src/. This skill ensures all documentation follows the project's CLAUDE.md constraints, uses correct admonition syntax, maintains consistent style with existing articles, and properly updates sidebar.ts and README.md indexes.

Web & Frontend 238 stars 11 forks Updated today GPL-3.0

Install

View on GitHub

Quality Score: 86/100

Stars 20%
79
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Update Docs This skill guides documentation updates for the eIsland VuePress docs site located at `web/eisland-web-docs/`. ## Core Rules These rules come from the project's `CLAUDE.md` and must be followed strictly: 1. **Language**: All documentation content must be written in **English**. No Chinese text allowed. 2. **Admonitions**: Every documentation file MUST use admonition syntax. Each file should include at least one admonition block (`:::tip`, `:::info`, `:::note`, `:::important`, `:::warning`, `:::danger`, or `:::details`). Use a variety of admonition types — do not rely on a single type. 3. **Sidebar**: Do NOT register `README.md` files in the sidebar. VuePress automatically uses each subdirectory's `README.md` as the category index page. 4. **Frontmatter**: Every doc file must have YAML frontmatter with `title` and `icon` fields. 5. **Test Statistics**: When documenting test coverage, use accurate numbers from the latest test run: **125 test files**, **2068 tests**. Update these numbers when new test results show different counts. ## Documentation Structure ``` src/ ├── introduction/ # Project introduction and architecture │ ├── intro/ # Project introduction │ ├── tech-stack/ # Technology stack │ ├── frontend-arch/ # Frontend architecture │ └── backend-arch/ # Backend architecture └── developer/ # Developer guide ├── environment-setup/ # Environment configu...

Details

Author
JNTMTMTM
Repository
JNTMTMTM/eIsland
Created
4 months ago
Last Updated
today
Language
TypeScript
License
GPL-3.0

Similar Skills

Semantically similar based on skill content — not just same category