docs: second-pass hardening polish for v1.1.1#14
Conversation
Agent-Logs-Url: https://github.com/dfeen87/Goodwill-KPI/sessions/d64ba090-9b03-4a9b-aba0-7e3cd1b02f96 Co-authored-by: dfeen87 <158860247+dfeen87@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Documentation-only polish for the v1.1.1 release, focused on keeping the documented repository layout and licensing wording consistent with the actual repo contents.
Changes:
- Update the repository tree in
README.mdto includetests/test_config.pyand clarify the LICENSE description. - Remove stale “Repository Tree Update” artifacts from multiple docs pages under
docs/. - Bump
CITATION.cffversion from1.1.0to1.1.1.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates the documented repo structure and LICENSE description. |
| docs/CALIBRATION.md | Removes stale autogenerated repository-tree section. |
| docs/INPUT-GOVERNANCE.md | Removes stale autogenerated repository-tree section. |
| docs/OBSERVABILITY.md | Removes stale autogenerated repository-tree section. |
| docs/SECURITY.md | Removes stale autogenerated repository-tree section. |
| CITATION.cff | Bumps citation version to 1.1.1. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| license: non-commercial | ||
| repository-code: "https://github.com/dfeen87/Goodwill-KPI" | ||
| version: "1.1.0" | ||
| version: "1.1.1" |
There was a problem hiding this comment.
CITATION.cff is now 1.1.1, but the runtime/app version is still 1.1.0 (goodwill/__init__.py:__version__, consumed by app/main.py). This will make the FastAPI OpenAPI version and any consumers of goodwill.__version__ inconsistent with the citation metadata; consider bumping the package __version__ (and any other version sources) to match, or keep CITATION.cff at 1.1.0 until the code version is updated.
| version: "1.1.1" | |
| version: "1.1.0" |
Second-pass documentation polish pass targeting v1.1.1. No code or logic changes.
Changes
CITATION.cff1.1.0→1.1.1README.mdtest_config.pyto the repository tree (file exists, was omitted from docs)LICENSEcomment:"Non-commercial license"→"Hybrid non-commercial / commercial license"(reflects actual license terms)docs/CALIBRATION.md,INPUT-GOVERNANCE.md,OBSERVABILITY.md,SECURITY.mdCITATION.cffandLICENSElisted underdocs/,test_config.pyabsent). Authoritative tree lives in rootREADME.md.