Skip to content

Contributing to the Wiki

Lucenx9 edited this page Mar 3, 2026 · 1 revision

Contributing to the Wiki

This page keeps the wiki maintainable and easy to navigate.

Editing Workflow

  • 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.

Writing Rules

  • 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 --help and agentinit <command> --help).

Navigation Rules

  • 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).

Page Naming

GitHub wiki page names must not contain these characters: \\, /, :, *, ?, ", <, >, |

Change Control

  • 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.

Clone this wiki locally