Developer documentation for src/features #11943
vanillaHill
started this conversation in
Show and tell
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Hey ShapeShift team
I've been working on GitScribe, a tool that generates developer documentation from codebases using AST analysis + AI.
I ran it against your web repo -
src/featuresdirectory and the result is here:https://web.gitscribe.dev/
It covers module architecture, key APIs, and cross-module dependencies — all inferred from your actual code (imports, exports, symbols), not just README summaries.
A few things it picked up:
This is fully automated — no manual annotation needed. If it's useful, happy to regenerate on demand as the codebase evolves, or help set up CI-based doc updates.
Feedback very welcome — especially on what's missing or wrong. That helps us improve the generation quality.
Feel free to close if it’s not relevant — no pressure at all.
Beta Was this translation helpful? Give feedback.
All reactions