create-user-facing-docs
Installation
SKILL.md
User-facing documentation (Orion-docs)
Scope and location
- Default path:
Orion-docs/docs/in the monorepo (published at docs.orion-agent.ai). Write for end users, not engineers maintaining the repo. - Getting started articles:
Orion-docs/docs/getting-started/ - Troubleshooting / how-tos:
Orion-docs/docs/troubleshooting/ - Do not put user-facing articles in
Orion-app/docs/unless the user explicitly asks—that folder is internal/developer-oriented. - After adding or renaming a page, register it in
Orion-docs/docs/.vitepress/config.tssidebar.
Before writing
- Read one existing file in
Orion-docs/docs/troubleshooting/(for examplechatgpt-codex-device-authorization.md) and match heading style, tone, and density. - Clarify the outcome: What should the user be able to do after reading? Prefer numbered steps for procedures (especially fixes).
- If the doc addresses a GitHub issue, fetch or confirm title/body with
gh issue view <n>and link the issue at the end; keep the article useful even if someone lands without issue context.