Skip to content

Consolidate public documentation and finalize PyPI guidance - #9

Merged
sohams25 merged 1 commit into
mainfrom
maintenance/final-public-cleanup
Jul 22, 2026
Merged

Consolidate public documentation and finalize PyPI guidance#9
sohams25 merged 1 commit into
mainfrom
maintenance/final-public-cleanup

Conversation

@sohams25

Copy link
Copy Markdown
Owner

What changed

Deleted (process records already represented by CHANGELOG.md and the v0.3.0 GitHub Release):

  • RELEASE_READINESS_REPORT.md
  • PUBLIC_RELEASE_REPORT.md
  • RELEASE_NOTES_DRAFT.md
  • docs/marketing/ (post draft only)

Moved / consolidated:

  • SECURITY_REVIEW.md → docs/SECURITY_MODEL.md (durable trust model kept; review-process prose removed)

PyPI guidance: earlyon==0.3.0 is live on PyPI with trusted-publishing attestations from this repository's release workflow, verified by a fresh-venv install and import/routing/calibration/checkpoint/migration/staged smoke from outside the source tree. README now leads with pip install earlyon==0.3.0 (GitHub tag install kept as secondary) and the static version badge is replaced with a live PyPI badge.

Housekeeping: removed local-tooling ignore entries from the tracked .gitignore; updated CHANGELOG and release-checklist references.

Unchanged

Validation

  • pytest: 270 passed (incl. 6 CUDA tests via -m gpu)
  • mypy --strict, ruff, black --check, isort --check-only: clean
  • python -m build + twine check: PASSED
  • All relative markdown links verified to resolve
  • Fresh-venv pip install earlyon==0.3.0: import, version, model build, training forward, routed inference, calibration, v2 round trip, v1 migration, staged/eager equivalence, CLI help — all pass

Delete release-process reports and the marketing draft directory; move
the security review to docs/SECURITY_MODEL.md with process prose removed;
point the README install at the live PyPI release with a pypi version
badge; drop local-tooling ignore entries from the tracked .gitignore.
No code, version, or packaging changes.
@sohams25
sohams25 merged commit 6c723e0 into main Jul 22, 2026
3 checks passed
@sohams25
sohams25 deleted the maintenance/final-public-cleanup branch July 22, 2026 13:59
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