Skip to content

docs(grading-tiers): describe the study data and scripts without local paths - #748

Open
xaleryb wants to merge 2 commits into
intel:mainfrom
xaleryb:docs/grading-tiers-no-local-paths
Open

xaleryb wants to merge 2 commits into
intel:mainfrom
xaleryb:docs/grading-tiers-no-local-paths

Conversation

@xaleryb

@xaleryb xaleryb commented Nov 14, 2026

Copy link
Copy Markdown
Contributor

Follow-up to #472. docs/grading-tiers.md described where the study data and the prototype scripts live with local paths and a machine name that a reader of the repository cannot reach. The page now says what the data is and that the scripts are not in the repository, without naming a location.

Docs only; no code, test or CLI change.

…l paths

Signed-off-by: Alexander Rybkin <alexander.rybkin@intel.com>
@xaleryb
xaleryb requested a review from a team as a code owner November 14, 2026 09:00
@exai-bot

exai-bot commented Nov 14, 2026 •

Copy link
Copy Markdown

✅ OpenCodeReview: Review complete: 0 finding(s) across 1 selected item(s).

CI at 5edabca: 21 passing, 3 skipped.

Review details
  • Commit reviewed: 5edabca against merge base 832b00f
  • Coverage: 1 files in 1 groups
  • Engine: OpenCodeReview v1.13.5-exai.4.8f73eada, us.openai.gpt-6.1-sol
  • Usage: 7k tokens (0 from cache), 3s
  • Tool calls: 0
  • dokimi/docs/grading-tiers.md: 1 file

@codecov-commenter

codecov-commenter commented Nov 14, 2026 •

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.72%. Comparing base (832b00f) to head (5edabca).
⚠️ Report is 18 commits behind head on main.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #748      +/-   ##
==========================================
- Coverage   95.73%   95.72%   -0.02%     
==========================================
  Files         408      415       +7     
  Lines       54644    55346     +702     
  Branches     9404     9514     +110     
==========================================
+ Hits        52315    52979     +664     
- Misses       1439     1465      +26     
- Partials      890      902      +12     

see 38 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@antonwolfy antonwolfy 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.

LGTM. The rewrite removes the lab-box paths and the machine name, and what it says in their place (the data is not published, the scripts are not in the repository) agrees with the rest of the page. Nothing else in the docs links to the removed text. One nit inline.

What I ran, on a Linux review host at 2dbc367:

  • make ci-local: 31 passed, 1 failed, 14 skipped. The one failure is Run tests: 19,949 passed, and 2 errors that are 60 s setup timeouts in tests/test_audit_test_quality.py, which the PR does not touch. That file passes alone (172 passed in 14 s), so it is load, not the PR. mkdocs build, Docs pages to review, schema_compat, mypy and the changed-line coverage step pass.

Checked, no issues

  • Leftover paths: no localdisk, napetrov path, skill-content-intel, detpilot or lab box remain in grading-tiers.md.
  • Links: no page links to an anchor in the Prototype or Reproducing sections; every reference is to the whole page.
  • Commits: the one commit carries a Signed-off-by.

Comment thread dokimi/docs/grading-tiers.md Resolved
Signed-off-by: Anton Volkov <antonwolfy@gmail.com>

@antonwolfy antonwolfy 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.

LGTM. I pushed a commit per nit, up to 5edabca, which fix the nit from my review:

  • 5edabca: dokimi/docs/grading-tiers.md:316: re-flowed the Reproducing paragraph to the suggested four lines of about 90 characters.

make ci-local at 5edabca: 32 passed, 0 failed, 14 skipped.

@vchamarthi vchamarthi 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.

Ready to merge at 5edabca: Docs-only rewrite of two passages in grading-tiers.md that removes the local paths and machine name; the text now matches the rest of the page and nothing blocks it.

Verified

  • Merge: The PR merges onto current main with no conflict.
  • Full suite: The full test suite passes with main merged in.
  • Leftover paths: dokimi/docs/grading-tiers.md no longer contains localdisk, napetrov, detpilot or lab box (grep on the head returns nothing).

This branch has not been deployed

No deployments
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.

5 participants