Original idea/motivation Tweet (though the original idea didn't include the wiki backlinks in comments)
You remember the old "this is why you shouldn't interrupt a programmer" comic?
There are many "visualize X piece of a project in code" but none where X is "docs/comments/second-brain".
Represent code/architecture as hand-built graphs that lives in a language-agnostic way alongside the code.
- How do you have code review comments/questions live alongside code in a non-intrusive way?
- Probably a separate project entirely
- Separate CLI tool with VS Code extension to use it?
- Pure
git
integration (+ GitHub/GitLab connectors)
- CMD+click to follow wiki-style links (with line/row/col numbers, or hash of line?)
- Table view of nodes that link to/from currently viewed node, support CMD+CLICK
- Eclipse Sprotty vs Mermaid.js for rendering graphs (with comments)?
- Original code flow extension:
- Code Tour (does what I want, but doesn't store the "tours" as regular text/comments)
- VS Code markdown notes (these do what I want, but only for markdown files)
- A cool concept to consider:
- A similar extension for inline bookmarks, but no linking:
- VS Code relative file link are apparently broken:
- Commercial products:
- https://code.visualstudio.com/api/get-started/your-first-extension
- https://github.com/microsoft/vscode-extension-samples
- https://www.typefox.io/blog/using-sprotty-in-vs-code-extensions/
Also see the Yeoman generated README here.