Skip to content

docs: document mark-pdf-ready utility - #2428

Open
tomatotomata wants to merge 1 commit into
santifer:mainfrom
tomatotomata:codex/docs-mark-pdf-ready-2425
Open

docs: document mark-pdf-ready utility#2428
tomatotomata wants to merge 1 commit into
santifer:mainfrom
tomatotomata:codex/docs-mark-pdf-ready-2425

Conversation

@tomatotomata

@tomatotomata tomatotomata commented Aug 2, 2026

Copy link
Copy Markdown

Summary

Closes #2425.

  • Document mark-pdf-ready.mjs in the agent-invoked utilities table and its own reference section.
  • Describe the report-number selector, web PDF render caller, shared lock, atomic write, idempotent behavior, and exit codes.
  • Keep the wording aligned with the existing fix-slugs and set-status.mjs entries.

Validation

  • node tests/mark-pdf-ready.test.mjs passes (18 checks).
  • node --check mark-pdf-ready.mjs passes.
  • git diff --check passes.
  • node test-all.mjs --quick reached 2,755 passing tests and one unrelated DNS-resolution failure in the existing SSRF redirect fixture (example.com resolved to no addresses in this environment).

This is a documentation-only change. No runtime behavior or dependencies were changed.

Summary by CodeRabbit

  • Documentation
    • Added the PDF readiness utility to the agent-invoked utilities reference.
    • Documented supported report-number input, dry-run and JSON modes, report-to-tracker resolution, ambiguity handling, idempotent behavior, shared locking, atomic writes, and exit codes.
    • Clarified expected outcomes for successful operations, no-op updates, ambiguous matches, invalid input, and execution errors.

@github-actions

github-actions Bot commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

Welcome to career-ops, @tomatotomata! Thanks for your first PR.

A few things to know:

  • Tests will run automatically — check the status below
  • Make sure you've linked a related issue (required for features)
  • Read CONTRIBUTING.md if you haven't

We'll review your PR soon. Join our Discord if you have questions.

@coderabbitai

coderabbitai Bot commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 34c4ac86-9e60-4091-9f46-f13d84c3f499

📥 Commits

Reviewing files that changed from the base of the PR and between 0573935 and bb88f8b.

📒 Files selected for processing (1)
  • docs/SCRIPTS.md

📝 Walkthrough

Walkthrough

The script reference now includes mark-pdf-ready.mjs. It documents inputs, modes, tracker resolution, ambiguity handling, idempotency, locking, atomic writes, command forms, and exit statuses.

Changes

Script documentation

Layer / File(s) Summary
mark-pdf-ready.mjs command reference
docs/SCRIPTS.md
Adds the utility to the agent-invoked command table and documents its arguments, modes, tracker updates, resolution rules, locking, atomic replacement, and exit statuses.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

Suggested reviewers: schlaflied, scott-emberson, luochen211

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the documentation change for the mark-pdf-ready utility.
Linked Issues check ✅ Passed The PR documents mark-pdf-ready.mjs in docs/SCRIPTS.md, including its behavior, caller, arguments, and exit codes as required by issue #2425.
Out of Scope Changes check ✅ Passed The changes are limited to documentation for mark-pdf-ready.mjs and match the scope of issue #2425.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

Signed-off-by: ahmadalguydi <ahmadalgaidy@hotmail.com>
@tomatotomata
tomatotomata force-pushed the codex/docs-mark-pdf-ready-2425 branch from 0573935 to bb88f8b Compare August 2, 2026 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: document mark-pdf-ready.mjs in docs/SCRIPTS.md

1 participant