feat: use docgen as an external tool (no vendored library in project src) - #64
Merged
Conversation
Document pip/pipx/uv installs, add docgen --version, and have init write requirements-docgen.txt plus a bundle README so consumers keep only the demo bundle in-repo instead of copying documentation-generator source. Co-authored-by: John Menke <jmjava@gmail.com>
Add GET /api/tool and POST /api/tool/update so maintainers can pip-upgrade the external docgen package from the GUI (canonical git URL only), rewrite requirements-docgen.txt, and be prompted to restart the wizard. Co-authored-by: John Menke <jmjava@gmail.com>
jmjava
marked this pull request as ready for review
August 2, 2026 02:14
Contributor
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Makes the intended consumer model explicit and usable from the wizard:
docgenvia pip/pipx/uv (not vendored into projectsrc/).pip install --upgradea git ref, optionally rewritingrequirements-docgen.txt.Changes
docgen --versionpip installlinedocgen initrequirements-docgen.txt+ bundleREADME.mdinstall_spec.pyupdate_docgen_installGET /api/tool,POST /api/tool/update(canonical GitHub URL only; restart required)Consumer flow
Test plan
pytest tests/(full suite)/api/tool+/api/tool/update