docs: polish public onboarding and demo path#4
Merged
Conversation
- Replace registry install guidance with verified GitHub release and source install paths - Add a no-token demo path and mark historical plans as non-authoritative - Clarify release tag cadence and public-facing local workspace wording Tests: python3 -m pytest -q -p no:cacheprovider; ruff check src/ tests/; make demo; gitleaks detect --source . --redact --verbose; uvx/pipx GitHub install help smokes
- Remove docs-only path ignores now that the repository is public - Update workflow docs to match the required branch-protection check Tests: python3 -m pytest -q -p no:cacheprovider; ruff check src/ tests/; git diff --check; gitleaks detect --source . --redact --verbose
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
1 participant
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.
What
Why
The repo is public now, so first-time readers need install and demo instructions that work today instead of assuming a PyPI/package-index publication that has not happened yet.
How
audit.pyzand GitHub-sourceuv/pipxpaths.docs/plans/README.mdto explain historical notes without deleting useful project history.Testing
python3 -m pytest -q -p no:cacheprovider- 2066 passed, 2 skipped, 1 warning.ruff check src/ tests/- passed.make demo- generated demo report, workbook, HTML dashboard, and control-center artifacts.gitleaks detect --source . --redact --verbose- no leaks found.uvx --from git+https://github.com/saagpatel/GithubRepoAuditor.git audit --help- passed.pipx run --spec git+https://github.com/saagpatel/GithubRepoAuditor.git audit --help- passed.uvx --from 'github-repo-auditor[serve] @ git+https://github.com/saagpatel/GithubRepoAuditor.git' audit serve --help- passed.pipx run --spec 'git+https://github.com/saagpatel/GithubRepoAuditor.git#egg=github-repo-auditor[serve]' audit serve --help- passed.Performance Impact
None expected; docs-only change.
Risk / Notes
git pushwas blocked by app policy, so the branch commit was created through the GitHub API.