Skip to content

docs: polish public project surface#9

Merged
saagpatel merged 1 commit into
mainfrom
codex/public-polish
May 18, 2026
Merged

docs: polish public project surface#9
saagpatel merged 1 commit into
mainfrom
codex/public-polish

Conversation

@saagpatel
Copy link
Copy Markdown
Owner

What

  • Replaces placeholder README badges with live CI, PyPI, Python, release, and license badges.
  • Refreshes release-gate, workflow, and web UI install docs now that PyPI publishing is active.
  • Tightens contributor and security docs for public users.

Why

  • The project is now public and published on PyPI, so first-time visitors should see current trust signals and accurate release guidance.

How

  • Keeps the change docs-only, with a distribution policy test guarding the public install and badge copy.
  • Leaves release mechanics unchanged; this only updates public-facing documentation.

Testing

  • ruff check src/ tests/
  • python3 -m pytest tests/test_distribution_policy.py -q -p no:cacheprovider
  • python3 -m pytest -q -p no:cacheprovider

Performance Impact

  • None expected; docs/test-only change.

Risk / Notes

  • Repository homepage was also set to the PyPI project page in GitHub metadata.

- replace placeholder README badges with live public status badges
- refresh release and workflow docs for active PyPI publishing
- tighten contributor and security guidance for public users

Tests: ruff check src/ tests/; python3 -m pytest tests/test_distribution_policy.py -q -p no:cacheprovider; python3 -m pytest -q -p no:cacheprovider
@saagpatel saagpatel merged commit 8b090e4 into main May 18, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant