This documentation is a work in progress!
CodeStory is designed to help you describe the inner workings of your software projects in a whole new way.
Its most remarkable feature is the ability to incorporate live, editable views of your code base right into your notes.
CodeStory also works together with git to connect your documentation notes to your code, and vice versa.
Not only are the code views inside your notes always up-to-date, but they also are if you rename or move your files, or even refactor your code!
Sequence diagrams offer an alternate way of describing a mechanism that involves somewhat complicated operations.
Sequence diagrams can point to notes that will show up when you hover over the relevant parts!
CodeStory features a unique WYSIWYG editor which lets you build rich diagrams that reveal your code as you hover over the relevant parts.
Notes are hierarchical: any note can be the parent of children notes.
The table of contents reflects that hierarchy.
However, most of your notes probably don't need to show up there. Hence the option to disable “feature in TOC” when you create a new note (also modifiable later on).
The Notes Browser displays all the notes in a flat, sortable, filterable list.
One keyboard shortcut away, fast and works offline!
How often do you browse through some code and come across something you'd like to know the context of?
Plug-ins for VSCode and Jetbrain are available (Atom and Sublime soon).
