Skip to content

Comments

chore: README overhaul, dynamic version, domain migration, and docs alignment#112

Merged
seanbrar merged 2 commits intomainfrom
chore/cleanup-domain-codecov-readme
Feb 17, 2026
Merged

chore: README overhaul, dynamic version, domain migration, and docs alignment#112
seanbrar merged 2 commits intomainfrom
chore/cleanup-domain-codecov-readme

Conversation

@seanbrar
Copy link
Owner

Summary

Rewrites the README to showcase multi-provider support, structured output, YouTube/arXiv sources, and stronger feature messaging. Migrates all doc URLs from seanbrar.github.io/pollux to polluxlib.dev, replaces the hardcoded __version__ with importlib.metadata, and aligns the docs homepage/index vocabulary with the new README.

Related issue

None

Test plan

Non-behavioral change — docs, config URLs, and version metadata only. No library logic changed.

  • make check passes (lint, typecheck, 66 tests): all green
  • python -c "from pollux import __version__; print(__version__)"1.0.0rc2 (confirms importlib.metadata resolution)
  • Verified docs/CNAME contains polluxlib.dev for GitHub Pages custom domain

Notes

  • __version__ uses version("pollux-ai") (the PyPI distribution name), not __name__ (which resolves to pollux, the import name). Falls back to "0.0.0+unknown" if the package isn't installed.
  • Codecov upload is now gated to a single matrix entry (Python 3.13) to avoid duplicate reports.
  • Homepage tagline, feature card titles, and model names in docs were aligned with README to eliminate presentation discrepancies.

  • PR title follows conventional commits
  • make check passes
  • Tests cover the meaningful cases, not just the happy path
  • Docs updated (if this changes public API or user-facing behavior)

Sean Brar added 2 commits February 16, 2026 13:24
…lignment

- Rewrite README to showcase multi-provider support, structured output,
  YouTube/arXiv sources, and stronger feature messaging
- Replace hardcoded __version__ with importlib.metadata lookup
- Migrate all URLs from seanbrar.github.io/pollux to polluxlib.dev
- Align docs homepage and index.md vocabulary with README
  (tagline, feature bullets, model names)
- Enable Codecov upload from a single CI matrix entry
- Update uv.lock to 1.0.0-rc.2
…load

The coverage path appended --cov flags to `make test`, which make can't
parse (exit code 2). Add a `test-cov` target and call it directly when
upload-coverage is true.
@seanbrar seanbrar merged commit 7555f35 into main Feb 17, 2026
10 checks 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