Skip to content

docs: replace finding with assessment in the readme - #72

Merged
phantinuss merged 2 commits into
masterfrom
docs/TH-1338/readme-replace-finding-with-assessment
Oct 14, 2026
Merged

phantinuss merged 2 commits into
masterfrom
docs/TH-1338/readme-replace-finding-with-assessment

Conversation

@PierreBaronNextron

Copy link
Copy Markdown
Contributor

No description provided.

@PierreBaronNextron PierreBaronNextron self-assigned this Oct 13, 2026
@PierreBaronNextron PierreBaronNextron added the documentation Improvements or additions to documentation label Oct 13, 2026
Comment thread README.md Outdated

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.

🟢 Approval recommended

The documentation accurately reflects the existing v3 API and event model.

0 open findings

What changed in this PR

Updates README terminology to match the v3 Assessment model.

Changes:

  • Replaces “finding” with “assessment.”
  • Documents assessment scores, reasons, subjects, and ancestors.
File Description
README.md Aligns v3 documentation with current assessment terminology.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.md Outdated
@phantinuss
phantinuss merged commit e6f69a0 into master Oct 14, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants