Docs/reference and operation

[whisper67265]

Close #50, close #49.

Summary by CodeRabbit

• Documentation

  • Replaced the operator quick reference with an expanded end-to-end “Getting Started” walkthrough.
  • Updated links across the docs and README to reference the new guide.
  • Added detailed operator checklist, dispatch ordering, verification steps, and result interpretation.

• Tests

  • Added Bats coverage to confirm the Getting Started doc exists, contains expected sections/references, and that the old operator quick reference is no longer present.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8dd09522-f201-497d-9a0f-1cce14c8926b

📥 Commits

Reviewing files that changed from the base of the PR and between 330aada and 1beff07.

📒 Files selected for processing (1)

• docs/GETTING-STARTED.md

---

📝 Walkthrough

Walkthrough

docs/OPERATOR.md is removed and replaced with a new, expanded docs/GETTING-STARTED.md containing an end-to-end operator walkthrough with per-step verification for add-submodules, start-translation, sync-translation, and create-tag workflows. README.md, docs/ARCHITECTURE.md, docs/endpoint-contract.md, and CHANGELOG.md are updated to reference the renamed doc, and new Bats tests validate its content.

Changes

Operator Documentation Rename

Layer / File(s)	Summary
New GETTING-STARTED.md overview and setup docs/GETTING-STARTED.md	Adds document scope, related-docs references, Mermaid workflow overview, operator checklist table, prerequisites (secrets/vars), and optional local trigger setup instructions.
Dispatch step documentation docs/GETTING-STARTED.md	Details add-submodules, start-translation, sync-translation, and create-tag steps including dispatch payloads, expected repo/mirror state changes, Weblate notification behavior, idempotency, and verification checklists.
Results interpretation and decision guide docs/GETTING-STARTED.md	Adds sections explaining return-code collapsing for step exits and a quick decision guide mapping scenarios to workflow steps.
Cross-reference updates README.md, docs/ARCHITECTURE.md, docs/endpoint-contract.md, CHANGELOG.md, docs/OPERATOR.md	Removes docs/OPERATOR.md and updates links/wording in README, ARCHITECTURE, endpoint-contract, and CHANGELOG to reference docs/GETTING-STARTED.md instead.
New Bats tests tests/test_getting_started.bats	Adds tests verifying GETTING-STARTED.md existence, headings, checklist table, cross-links, script/token mentions, and absence of docs/OPERATOR.md.

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

Possibly related PRs

• cppalliance/boost-docs-translation#4: Introduces the endpoint contract doc that this PR's docs/endpoint-contract.md update references with the renamed operator guide link.
• cppalliance/boost-docs-translation#8: Introduces/frames docs/ARCHITECTURE.md, whose cross-reference this PR updates from OPERATOR.md to GETTING-STARTED.md.
• cppalliance/boost-docs-translation#53: Also modifies docs/OPERATOR.md content, in the same doc area this PR removes/renames.

Suggested reviewers: henry0816191, wpak-ai

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title is generic and does not convey the main change in the docs.	Rename it to something specific, e.g. 'Add end-to-end getting-started walkthrough and remove OPERATOR.md'.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check	✅ Passed	The doc rewrite, reference updates, OPERATOR.md removal, and new tests match issue #50's acceptance criteria.
Out of Scope Changes check	✅ Passed	The PR stays focused on documentation, reference cleanup, and a supporting test file.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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