docs: move oabctl usage guide to docs/oabctl.md, link from README#1289
Merged
Conversation
operator/README.md had grown into a comprehensive usage guide (manifest schema, ingress/webhooks, secrets formats, bootstrap, IAM tables, commands reference) mixed in with the tool's architecture overview - and nothing in the top-level README pointed at it at all, so it wasn't discoverable outside the operator/ directory. Split it: docs/oabctl.md is now the full usage guide (matches the flat docs/*.md convention used by every other feature doc), and operator/README.md is trimmed to an architecture/source-layout overview with a prominent link to docs/oabctl.md for usage. Added an 'AWS ECS Deployment' section to the top-level README (mirroring the existing 'Kubernetes Deployment' section) linking to docs/oabctl.md, so oabctl is now discoverable from the project's front door. No content was dropped - operator/README.md's usage sections moved verbatim to docs/oabctl.md; only the architecture diagram, quick start, and a new source-layout section stayed in operator/README.md.
Collaborator
Author
|
LGTM ✅ — Clean doc restructuring; content moved verbatim with correct relative links. What This PR Does
How It Works
Findings
What's Good (🟢)
Baseline Check
|
thepagent
approved these changes
Jul 4, 2026
Collaborator
Author
|
LGTM ✅ — Clean documentation restructure that improves discoverability without dropping content. What This PR DoesThe How It WorksPure content move — no additions or deletions of substance. Findings
What's Good (🟢)
Baseline Check
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
operator/README.mdhad grown into a comprehensiveoabctlusage guide —manifest schema, ingress/webhooks, secrets formats, bootstrap, IAM tables,
commands reference — mixed in with the tool's architecture overview. Worse,
nothing in the top-level
README.mdpointed at it, sooabctlwasn'tdiscoverable from the project's front door at all.
Changes
docs/oabctl.md— the full usage guide, moved verbatim (installation,quick start, complete workflow, configuration, manifest schema
including ingress/webhooks, bootstrap, IAM tables,
spec.secretsformats, state store, commands reference, prerequisites/permissions).
Matches the flat
docs/*.mdnaming convention every other feature docin the repo already uses.
operator/README.md— now just the architecture overview(the "How It Works" diagram), a short quick start, a new source-layout
section, and a prominent link to
docs/oabctl.mdfor full usage.README.md— added an "AWS ECS Deployment" section(mirroring the existing "Kubernetes Deployment" section) linking to
docs/oabctl.md, sooabctlis now discoverable without already knowingoperator/exists.No content was dropped — every usage section moved as-is. Internal relative
links were re-checked and confirmed correct from
docs/oabctl.md's newlocation (
../operator/README.md,../operator/schema/oabservice-v2.json,telegram.md,refarch/telegram-cloudflare-tunnel.md).Testing done
Doc-only change — no code touched. Verified all relative markdown links in
the moved/edited files resolve to real files at their new/updated paths via
glob/grep, no build or test run needed.