Skip to content

docs: remove calculation source fingerprint review gate - #5390

Merged
arturcic merged 3 commits into
GitTools:mainfrom
arturcic:codex/remove-docs-fingerprints
Oct 20, 2026
Merged

arturcic merged 3 commits into
GitTools:mainfrom
arturcic:codex/remove-docs-fingerprints

Conversation

@arturcic

@arturcic arturcic commented Oct 20, 2026 •

Copy link
Copy Markdown
Member

Source fingerprints currently make unrelated C# edits require updates to all seven algorithm documentation review records. Remove the fingerprints, mandatory review reasons, and --review command so source content changes can pass without rewriting the map.

Keep structural validation for the seven sections, headings, source and test paths, diagram includes, nonempty source mappings, calculation-source coverage, and repository path boundaries. Remove the existing review records and update the maintenance guide, PR checklist, and CI step name.

Validation:

  • npm run test:algorithm-docs: 13 tests passed, including source edits without review metadata and structural validation failures.
  • npm run check:algorithm-docs: all seven section mappings passed.
  • npm run check:links: 66 Markdown files checked, zero violations.
  • Markdown lint for the changed guide and PR template, plus git diff --check: passed.
  • Hosted CodeRabbit review completed before the latest rebase with no actionable findings. Its function-documentation warning was addressed; that review reported 100% docstring coverage and all five pre-merge checks passed. The CLI review was unavailable because of its included-review limit and organization seat requirement.

Codex responding on behalf of @arturcic.

Summary by CodeRabbit

  • Documentation

    • Updated guidance for maintaining version-calculation documentation, including source references, mappings, diagrams, and validation checks.
    • Clarified coverage rules for new files, explicit mappings, empty sections, and unmapped calculation files.
    • Removed instructions for maintaining review records and source fingerprints.
  • Improvements

    • Documentation validation now focuses on mapping accuracy and source coverage.
    • Validation output provides clearer section and mapped-file information.

Copilot AI balanced review requested due to automatic review settings October 20, 2026 13:35

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@coderabbitai

coderabbitai Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: dd9aa6cd-9397-4f38-a40f-482d56cb669a
📥 Commits

Reviewing files that changed from the base of the PR and between b76da7c and 8db0b21.

📒 Files selected for processing: 1
  • docs/version-calculation-map.json
🚧 Files skipped from review as they are similar to previous changes: 1
  • docs/version-calculation-map.json

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 5 remain after this review.

📝 Walkthrough

The pull request removes source-fingerprint review records from the algorithm documentation checker and map. It updates mapping validation tests, maintenance guidance, the pull request checklist, and the workflow step label.

Changes: Algorithm documentation mappings

Layer / File(s) Summary
Mapping checker and validation coverage
docs/scripts/check-version-calculation.mjs, docs/scripts/check-version-calculation.test.mjs, docs/version-calculation-map.json
The checker no longer tracks source digests or review records. Tests cover mapping validation without review metadata, and the map no longer contains review entries.
Mapping maintenance guidance
docs/maintaining-version-calculation.md, .github/PULL_REQUEST_TEMPLATE.md, .github/workflows/docs.yml
The guidance and checklist describe updating affected explanations and diagrams and validating mappings. The workflow step label now refers to mapping verification.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 8db0b

This documentation-tooling change removes the fingerprint review gate and its stored records. No actionable merge-blocking risk is evident from the supplied changes.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: removing the calculation source fingerprint review gate.
Docstring Coverage Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 5 functions across 2 files. (1 skipped: 1 …
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 5 functions across 2 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@arturcic
arturcic force-pushed the codex/remove-docs-fingerprints branch from b76da7c to 8db0b21 Compare October 20, 2026 13:53
@sonarqubecloud

Copy link
Copy Markdown

@arturcic
arturcic merged commit d142a78 into GitTools:main Oct 20, 2026
50 checks passed
@arturcic
arturcic deleted the codex/remove-docs-fingerprints branch October 20, 2026 14:35
@mergify

mergify Bot commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

Thank you @arturcic for your contribution!

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.

2 participants