Skip to content

docs: make operator-doc example paths cross-platform (Windows) #374

Description

@HumanBean17

Context

PR #371 fixed the consumer-facing README (/tmp/... → relative tmp/..., plus a Git Bash/WSL note). The deeper operator docs were left as-is and still assume a Unix shell:

  • docs/JAVA-CODEBASE-RAG-CLI.md — e.g. git diff > /tmp/pr.diff, --diff-file /tmp/pr.diff
  • docs/MANUAL-VERIFICATION-CHECKLIST.md/tmp/verify_index, /tmp/verify_build.log, /tmp/calib_index

Action

Either swap the /tmp/... examples for relative/tempfile-style paths (as the README now uses), or add a brief note that the snippets are POSIX-shell and Windows operators should use Git Bash/WSL.

Acceptance

  • Operator-doc examples don't break on Windows cmd/PowerShell, or are clearly marked POSIX-only.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions