write-noridoc
Write or update documentation in the server-side noridocs system.
安装与使用
请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。
查看来源 ↗使用指南技能说明
Write Noridoc
Writes documentation to the server-side noridocs system.
When to Use
Use this when:
- Creating new server-side documentation
- Updating existing noridoc content
- Adding git repository links to docs
Use regular Write tool instead for:
- Local file modifications
- Files not managed by noridocs
Usage
node {{skills_dir}}/write-noridoc/script.js --filePath="@<repository>/path" --content="# Documentation" [--gitRepoUrl="https://github.com/..."]
Parameters
-
--filePath(required): Path in format@<repository>/<path>(e.g.,@my-repo/server/src/persistence)- Use
@<repository>/pathfor repository-scoped docs - Use
@/pathor plain paths forno-repositoryscope (backward compatible)
- Use
-
--content(required): Markdown content -
--gitRepoUrl(optional): Link to git repository
Repository Detection
The repository is automatically extracted from the filePath by the server:
-
@my-repo/server/src/api→ repository:my-repo -
@/server/src/api→ repository:no-repository -
server/src/api→ repository:no-repository
Repository names must be lowercase letters, numbers, and hyphens only.
Examples
Create repository-scoped noridoc
node {{skills_dir}}/write-noridoc/script.js \
--filePath="@my-repo/server/src/api" \
--content="# API Client
Provides access to Nori backend." \
--gitRepoUrl="https://github.com/username/my-repo"
Create noridoc without repository scope
node {{skills_dir}}/write-noridoc/script.js \
--filePath="@/server/src/api" \
--content="# API Client"
Output
Returns confirmation with version number (creates new version automatically).
Requirements
- Paid Nori subscription
- Configured credentials in
~/nori-config.json
使用示例
查看来源仓库中的使用示例与配置说明。
查看来源 ↗来源历史
- 收录时间
- 2026-01-20
- 索引更新时间
- 2026-01-28
- Branch
- main
收录与同步日期属于本站记录。源码修改历史请查看来源仓库。
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!