Skip to content

docs: Refresh README for 0.2.0; strengthen CONTRIBUTING conventions - #22

Merged
dshkol merged 1 commit into
mainfrom
docs/readme-refresh
Jun 12, 2026
Merged

docs: Refresh README for 0.2.0; strengthen CONTRIBUTING conventions#22
dshkol merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@dshkol

@dshkol dshkol commented Jun 12, 2026

Copy link
Copy Markdown
Owner

GitHub-facing docs audit for 0.2.0. Found and fixed:

  • Broken example (the important one): the README's "Variable Discovery Examples" still called pc.find_census_vectors("CA21", "median household income") — the pre-0.2.0 argument order removed in fix: Consolidate vector search and port R's exact/semantic/keyword modes #14. Corrected and verified against the live API.
  • Badges: "tests passing" and "R equivalence verified" were hardcoded static shields; replaced with the live GitHub Actions CI badge plus a PyPI version badge. Python floor badge corrected 3.7→3.8 to match the CI matrix.
  • Stale claims: "Recent Updates" (pre-0.2.0 content, "450+ integration tests", "4/4 cross-validation tests") replaced with a What's New in 0.2.0 section linking CHANGELOG.md and accurate test numbers.
  • Discoverability: LLM usage guide + llms.txt linked from the documentation list.
  • CONTRIBUTING.md: added the R-compatibility north star, the core code conventions (all HTTP via ResilientSession, string identifiers, new-public-function checklist), and a pointer to AGENTS.md.

🤖 Generated with Claude Code

README:
- Fix broken find_census_vectors example still using the pre-0.2.0
  argument order (verified the corrected call against the live API)
- Replace hardcoded tests/R-equivalence badges with the live CI badge
  and a PyPI version badge; Python floor corrected to 3.8
- Replace stale "Recent Updates" with a 0.2.0 summary linking the
  CHANGELOG; refresh testing-section claims to match reality
- Link the LLM usage guide and llms.txt from the documentation list

CONTRIBUTING:
- State the R-compatibility north star and core conventions
  (ResilientSession for all HTTP, string identifiers, public-function
  checklist); point to AGENTS.md for the architecture map

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

🧪 R Equivalence Validation Results

VALIDATION SUMMARY
======================================================================

See full validation report in artifacts.

@dshkol
dshkol merged commit f740574 into main Jun 12, 2026
6 checks passed
@dshkol
dshkol deleted the docs/readme-refresh branch June 12, 2026 16:02
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