-
Notifications
You must be signed in to change notification settings - Fork 0
Contributing to the Wiki
Lucenx9 edited this page Mar 3, 2026
·
1 revision
This page keeps the wiki maintainable and easy to navigate.
- Small edits: use GitHub web UI directly.
- Multi-page edits: clone the wiki repository and commit locally.
- Keep one topic per page; avoid long mixed pages.
- Keep pages in English.
- Use one
#H1 title per page. - Keep command examples copy-paste ready.
- Prefer fenced code blocks with language labels (
bash,json, etc.). - When adding a command, verify against live CLI help (
agentinit --helpandagentinit <command> --help).
- Every new page must be linked from
_Sidebar.md. - Keep Home focused on entry points, not full reference content.
- Use clear page names that describe outcomes (for example,
Troubleshooting,Commands).
GitHub wiki page names must not contain these characters:
\\, /, :, *, ?, ", <, >, |
- Prefer small commits with clear messages.
- Use wiki history to review and revert changes when needed.
- If a change impacts command behavior, update both wiki and repository
README.md.
Docs source of truth: README | Release notes: CHANGELOG | CLI reference: agentinit --help | Report docs issues: GitHub Issues