Motin Doc CLI

A CLI tool to scaffold standardized documentation structure for Motin projects, ready for AI completion.

Features

• 🚀 Initializes .docs/ directory with standardized structure.
• 🔧 Supports multiple stacks (Nuxt, Node, Python, etc.).
• 🤖 Embeds AI-friendly context and instructions in Markdown comments.
• 📦 Optional GitHub Workflow for automated AI documentation updates.

Installation & Usage

You can use the tool directly with npx without installing it globally:

npx scaffold-doc-cli

Or install it globally:

npm install -g scaffold-doc-cli
init-doc

Development

1. Clone the repository.
2. Install dependencies:

   npm install

3. Link the package globally:

   npm link

4. Navigate to your target project folder:

   cd ../my-project

5. Run the initialization command:

   init-doc

Generated Structure

my-project/
├── .docs/
│   ├── index.md        # Entry point with AI context
│   └── components.md   # Stack-specific (e.g., for Nuxt)
└── .github/
    └── workflows/
        └── ai-doc-sync.yml # (Optional) Workflow file