@arthurcorreadev/copilot-docs

TypeScript framework for installing and managing technical documentation in your projects. Easily select, copy, and integrate docs and instructions for multiple tools with a single CLI command.

Installation

npm install @arthurcorreadev/copilot-docs

How to Use

1. Run the CLI in your target project:

   npx project-c45-docs-installer

2. Select which documentation sets you want to install (based on the interactive prompt).
3. The selected docs will be copied to docs/frameworks and instructions to .github/instructions in your project.

Scripts

• npm run build: Compiles TypeScript from src/ to dist/.
• npm start: Runs the main compiled file.

Developer Workflow

• Source code: src/
• CLI logic: bin/install-docs.js
• Documentation registry: config.json
• Documentation content: src/docs/
• Instructions: .github/instructions/

Publishing

To publish to npm:

npm publish --access public

Project Structure

• src/: TypeScript source code
• dist/: Compiled output
• bin/: CLI entry point
• config.json: Documentation registry
• src/docs/: Documentation sets
• .github/instructions/: Markdown instructions for each tool

Example

To add ESLint docs to your project:

1. Install this package: npm install @arthurcorreadev/copilot-docs
2. Run: npx project-c45-docs-installer
3. Select "eslint" in the prompt. Docs will be copied to docs/frameworks/eslint and instructions to .github/instructions.