Skip to content

docs: second-pass hardening polish for v1.1.1#14

Merged
dfeen87 merged 1 commit into
mainfrom
copilot/polish-documentation-and-onboarding
Apr 5, 2026
Merged

docs: second-pass hardening polish for v1.1.1#14
dfeen87 merged 1 commit into
mainfrom
copilot/polish-documentation-and-onboarding

Conversation

Copilot AI commented Apr 5, 2026

Copy link
Copy Markdown
Contributor

Second-pass documentation polish pass targeting v1.1.1. No code or logic changes.

Changes

CITATION.cff

  • Version bump: 1.1.01.1.1

README.md

  • Added missing test_config.py to the repository tree (file exists, was omitted from docs)
  • Corrected LICENSE comment: "Non-commercial license""Hybrid non-commercial / commercial license" (reflects actual license terms)

docs/CALIBRATION.md, INPUT-GOVERNANCE.md, OBSERVABILITY.md, SECURITY.md

  • Removed Section 9 "Repository Tree Update" from all four files — stale generation artifacts showing an incorrect layout (CITATION.cff and LICENSE listed under docs/, test_config.py absent). Authoritative tree lives in root README.md.

@dfeen87
dfeen87 marked this pull request as ready for review April 5, 2026 16:37
Copilot AI review requested due to automatic review settings April 5, 2026 16:37
@dfeen87
dfeen87 merged commit d2a3794 into main Apr 5, 2026
6 checks passed
@dfeen87
dfeen87 deleted the copilot/polish-documentation-and-onboarding branch April 5, 2026 16:37

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md to include tests/test_config.py and clarify the LICENSE description.
  • Remove stale “Repository Tree Update” artifacts from multiple docs pages under docs/.
  • Bump CITATION.cff version from 1.1.0 to 1.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.

Comment thread CITATION.cff
license: non-commercial
repository-code: "https://github.com/dfeen87/Goodwill-KPI"
version: "1.1.0"
version: "1.1.1"

Copilot AI Apr 5, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
version: "1.1.1"
version: "1.1.0"

Copilot uses AI. Check for mistakes.
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.

3 participants