Skip to content
Development
Command

/route-docs

Override the project name used in scaffolded templates.

From plugin
nyann
741 skills41 commands3 hooks
> /plugin marketplace add thettwe/nyann
> /plugin install nyann@nyann-plugins

Command definition

route-docs.md
name: nyann:route-docs
description: >
  Change documentation storage routing (local, Obsidian, Notion, or
  per-type split) and regenerate the doc scaffold to match.
arguments:
  - name: routing
    description: >
      Routing spec. Examples: `all:local`, `all:obsidian`,
      `prd:notion,adrs:obsidian,research:local`. Unmentioned types fall
      back to local. `memory` is always local.
    optional: true
  - name: obsidian-vault
    description: Obsidian vault name (required when routing any target to Obsidian).
    optional: true
  - name: obsidian-folder
    description: Folder path within the Obsidian vault.
    optional: true
  - name: notion-parent
    description: Notion parent page ID or URL (required when routing any target to Notion).
    optional: true
  - name: mcp-targets
    description: Path to MCP doc-targets JSON from `bin/detect-mcp-docs.sh`. Required when routing any target to a non-local backend (Obsidian/Notion); the script validates chosen backends against `available[]`.
    optional: true
  - name: project-name
    description: Override the project name used in scaffolded templates.
    optional: true

**Plugin root:** This is a Claude Code plugin, NOT a CLI tool. Do NOT search via `which`, `npm list`, `pip list`, or `brew list`. This file is at `<plugin_root>/commands/`. All scripts: `<plugin_root>/bin/`. Read the matching `skills/*/SKILL.md` for the full flow.

/nyann:route-docs

Composes `bin/route-docs.sh` (DocumentationPlan) and `bin/scaffold-docs.sh` (local file creation) for post-bootstrap doc routing changes.

When to invoke

  • Switching from local docs to Obsidian or Notion.
  • Changing per-type routing (e.g. PRDs to Notion, ADRs to Obsidian).
  • Regenerating the doc scaffold after restructuring.

Output

1. A DocumentationPlan JSON showing each doc type and its target. 2. Scaffold-docs creates missing local files (idempotent — existing files are never overwritten). 3. MCP-routed targets are flagged for manual creation via the configured MCP server.

Storage strategies

| Spec | Strategy | |---|---| | `all:local` | `local` | | `all:obsidian` | `obsidian` | | `all:notion` | `notion` | | mixed per-type | `split` |

See also:

  • `/nyann:gen-claudemd` — refresh CLAUDE.md after rerouting
  • `/nyann:bootstrap` — initial project setup (includes routing)
  • `/nyann:doctor` — audit repo health including doc completeness
Read more
@thettwe
Ships withnyann

ငြမ်း is Burmese for scaffolding. Nyann is the Claude Code plugin that picks expert git defaults for your stack — branching, working hooks (Husky / pre-commit.com / lefthook), commits, releases, CI, docs — then keeps the repo on those rails through every PR

Stars on GitHub

Momentum

stars in total
7
Star history of thettwe/nyann on GitHub, a chart by star-history.com

Other commands on nyann.

apply

apply

Command

Path to an IacPlan JSON from a prior /nyann:plan run, to apply the exact previewed plan.

@thettwe@thettweInstall Command
bootstrap

bootstrap

Command

Optional profile name to apply. If provided, skip stack detection's recommendation step and load this profile via…

@thettwe@thettweInstall Command
branch

branch

Command

The branch slug (feature/bugfix/hotfix) or version string (release).

@thettwe@thettweInstall Command
check-prereqs

check-prereqs

Command

If passed, emit the probe results as JSON instead of the human table.

@thettwe@thettweInstall Command
cleanup-branches

cleanup-branches

Command

Branch to use as the merge target. Defaults to the profile's primary base branch (auto-resolved through `origin/HEAD`, `main`, or…

@thettwe@thettweInstall Command

More commands from other plugins.

build
Auto-invoked

build

Command

Implement tasks incrementally — build, test, verify, commit. Add "auto" to run the whole plan in one approved pass.

@addyosmani@addyosmaniInstall Command