CodebaseNotes

A VS Code extension that allows you to annotate your codebase's files AND folders directly on a project tree in the VS Code UI. Maintain clear documentation about the structure and purpose of the different parts of your codebase. Also serves as a great tool for onboarding or just personal learning. All notes are stored into a single json file that can be checked into a repo.

Features

Accessing CodebaseNotes

• You can access CodebaseNotes by clicking on the "CodebaseNotes" icon in the Activity Bar.
• Alternatively, use the keyboard shortcut:
  • Windows/Linux: Ctrl+Alt+C
  • macOS: Cmd+Option+C

Click on a file or folder and enter an annotation for it (it's autosaved)

You may put a number in front of your annotation to have it ordered by that in the Annotation List

If you right-click on a file, choose "Copy Relative Path" and paste that into an annotation, whenever this annotation is opened, it will also open the referenced file.

Your annotations are stored in a .codebasenotes-annotations.json file in your project's root directory. This file can be checked into a repo to share annotations with your team.

Requirements

• Visual Studio Code version 1.74.0 or higher

License

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

Support

If you encounter any problems or have any suggestions, please open an issue on our GitHub repository.

Happy coding with CodebaseNotes! 📝👨‍💻👩‍💻