Skip to content

docs(manual): fix P0 copy and layout issues#96

Open
thinksyncs wants to merge 5 commits intomainfrom
codex/manual-p0-fixes
Open

docs(manual): fix P0 copy and layout issues#96
thinksyncs wants to merge 5 commits intomainfrom
codex/manual-p0-fixes

Conversation

@thinksyncs
Copy link
Copy Markdown
Contributor

Summary

  • Fix the first batch of manual P0 issues around copy-paste safety, figure accuracy, table readability, and reference URL hygiene.

Changes

  • Normalize Ch.2 demo shell comments and replace the multitask showcase with task-specific artifact panels.
  • Clarify the deployment flow figure with artifact/runtime/validation layers.
  • Convert Ch.9 benchmark and runtime/license matrices into readable task/category lists.
  • Remove the tracked arXiv URL parameter and fix Ch.12 LaTeX-safe code/path rendering.

Testing

  • /opt/homebrew/bin/python3 tools/validate_tool_manifest.py --manifest tools/manifest.json --require-declarative
  • /opt/homebrew/bin/python3 -m unittest tests.test_packaged_tools_manifest tests.test_manifest_docs_references
  • make -C manual pdf
  • git diff --check
  • rg scan for smart quotes, en-dash CLI flags, python3tools, tracked URL params, and stale percent shell comments
  • pre-push hook: ruff, focused unit tests, offline smoke, real-image scenario preflight

Notes

  • Remaining manual overhaul tasks stay tracked in bd, including broader LaTeX escape cleanup and Ch.4 restructuring.

Copilot AI review requested due to automatic review settings April 29, 2026 10:11
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the LaTeX manual to address P0 documentation issues focused on copy/paste safety, figure clarity, table readability, and reference URL hygiene.

Changes:

  • Removes tracked parameters from an arXiv reference URL in the bibliography.
  • Improves LaTeX-safe rendering for tool names/paths and normalizes CLI/code formatting.
  • Replaces wide tables with readable task/category list layouts and refines figures (subfigure artifact panels, clarified deployment flow diagram).

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
manual/references.bib Removes tracked utm_source parameter from the arXiv URL.
manual/chapters/12_tool_registry.tex LaTeX-safe tool/path rendering; updates registry/tooling references and release workflow text formatting.
manual/chapters/09_parity_bench_protocols.tex Converts task/support and runtime/license matrices into more readable description-list “cards”; normalizes inline code rendering.
manual/chapters/02_installation.tex Improves demo command copy/paste safety; replaces multitask montage with per-task artifact subfigures; clarifies deployment flow figure with artifact/runtime/validation grouping.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

family: \cmd{pose6d_error}. Execution support: artifact-backed real
eval/parity for \cmd{torch}, \cmd{onnx}, \cmd{engine}, and
\cmd{torchscript}. This is a YOLOZU-native extension that compares backend
predictions artifacts honestly instead of claiming end-to-end
Copy link

Copilot AI Apr 29, 2026

Choose a reason for hiding this comment

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

In the pose6d task card, “compares backend predictions artifacts” reads like a grammatical typo. Consider changing to “prediction artifacts” to match the other entries (e.g., “depth artifacts”).

Suggested change
predictions artifacts honestly instead of claiming end-to-end
prediction artifacts honestly instead of claiming end-to-end

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.

2 participants