cursor-doc-automation v1.0.0

Cursor Documentation Automation Extension

This extension for Cursor IDE automates the process of generating documentation and managing tickets based on code changes.

Features

• Automatic documentation generation from code changes
• Integration with Jira for ticket management
• GitHub pull request automation
• Technical documentation analysis
• Related components identification

Installation

1. Clone this repository:

git clone https://github.com/yourusername/cursor-doc-automation.git
cd cursor-doc-automation

2. Install dependencies:

npm install

3. Build the extension:

npm run build

4. Create a .env file in the root directory with the following variables:

FUELIX_API_URL=your_fuelix_api_url
FUELIX_API_KEY=your_fuelix_api_key
FUELIX_MODEL_NAME=your_model_name
JIRA_PROJECT_KEY=your_jira_project_key
JIRA_API_TOKEN=your_jira_api_token
JIRA_EMAIL=your_jira_email
JIRA_DOMAIN=your_jira_domain
GITHUB_TOKEN=your_github_token
GITHUB_REPOSITORY=your_github_repository

Usage

1. Start the extension:

npm start

2. The extension will automatically:
   • Monitor code changes
   • Generate documentation
   • Create pull requests
   • Update Jira tickets

Testing

Run the documentation automation test:

npm run test-docs

Development

1. Make changes to the source code in the src directory
2. Build the extension:

npm run build

3. Test your changes:

npm run test-docs

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.