Skip to content

chore: standardize docs, license, funding, and CODEOWNERS#6

Merged
btli merged 2 commits into
mainfrom
chore/docs-standardization
Jun 3, 2026
Merged

chore: standardize docs, license, funding, and CODEOWNERS#6
btli merged 2 commits into
mainfrom
chore/docs-standardization

Conversation

@btli

@btli btli commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Standardizes this repository to the JoyfulHouse OSS documentation standard.

Changes

  • README.md — standard clean (no-emoji) structure with the consistent badge row.
  • INSTALL.md — new installation guide.
  • CHANGELOG.md — Keep a Changelog 1.1.0 + SemVer.
  • LICENSE — copyright holder JoyfulHouse Real Estate LLC.
  • .github/FUNDING.yml — GitHub Sponsors (btli) + Ko-fi (bryanli).
  • .github/CODEOWNERS* @btli.
  • docs/ — standard taxonomy; internal artifacts moved to docs/claude/.

Note: CHANGELOG date corrected from git tag.

Documentation, licensing, and metadata only — no source or functionality changes.

🤖 Generated with Claude Code

btli and others added 2 commits December 3, 2025 10:01
- Add TestIntegrationWithReferenceData class with real-world water chemistry
- Document differences between TFP/PoolMath CSI and Orenda LSI formulas
- CSI test validates against TFP Wojtowicz formula (-0.31)
- LSI test validates our precise log10 implementation (0.28)

Research findings documented in test comments:
- CSI uses ionic strength, CYA, and borate corrections
- Orenda LSI uses TDS-adjusted constants and table lookups
- Our LSI uses mathematically precise log10 calculations

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
- LICENSE: updated copyright to 2024-2026 JoyfulHouse Real Estate LLC
- .github/FUNDING.yml: copied canonical funding file (github: btli, ko_fi: bryanli)
- .github/CODEOWNERS: added (* @btli)
- README.md: instantiated README.pypi.md template; migrated all existing content;
  standardized badge row; no emoji headers; links INSTALL.md; API reference table;
  cross-links ha-poolchem; all tokens filled
- INSTALL.md: instantiated INSTALL.pypi.md template
- CHANGELOG.md: normalized to Keep a Changelog 1.1.0; fixed v0.1.0 date from
  2024-12-02 to 2025-12-02 (matches git tag); [Unreleased] at top; compare-link
  footer present
- docs/README.md: new canonical index linking standard docs and reference docs
- docs/ARCHITECTURE.md: new skeleton with component table and design decisions
- docs/USAGE.md: new usage guide with code snippets for all key workflows
- docs/DEVELOPMENT.md: new contributor setup and release process
- docs/TROUBLESHOOTING.md: new troubleshooting guide with common issues
- docs/claude/: created for internal artifacts
- pyproject.toml: author updated to JoyfulHouse Real Estate LLC; Changelog URL added

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@btli btli merged commit 167dab0 into main Jun 3, 2026
5 checks passed
@btli btli deleted the chore/docs-standardization branch June 3, 2026 03:15
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