Skip to content

fix: correct terminology and flag inconsistencies in docs - #323

Closed
Mesut Oezdil (mesutoezdil) wants to merge 6 commits into
agent-substrate:mainfrom
mesutoezdil:fix/doc-inconsistencies
Closed

fix: correct terminology and flag inconsistencies in docs#323
Mesut Oezdil (mesutoezdil) wants to merge 6 commits into
agent-substrate:mainfrom
mesutoezdil:fix/doc-inconsistencies

Conversation

@mesutoezdil

@mesutoezdil Mesut Oezdil (mesutoezdil) commented Jun 26, 2026

Copy link
Copy Markdown
Contributor
  • README.md: --template used with a space; cmd/kubectl-ate/README.md uses =. Aligned to =.
  • README.md: removed stale note about navigating to root before running hack/install-ate.sh; the script anchors itself with git rev-parse --show-toplevel.
  • docs/architecture.md: WarmPools is not a project term; changed to WorkerPools.
  • docs/architecture.md: missing to in "it's important clarify".
  • COLLABORATING.md: (GMT-7) is only correct during PDT; changed to (PT).
  • docs/api-guide.md: pauseImage example uses a GKE-specific image with no note for other clusters; added a comment with the generic alternative.

@thockin

Copy link
Copy Markdown
Collaborator

It looks like checks are stuck and I don't know why

@mesutoezdil

Copy link
Copy Markdown
Contributor Author

It looks like checks are stuck and I don't know why

A similar situation sometimes occurs in other repos as well

@mesutoezdil
Mesut Oezdil (mesutoezdil) force-pushed the fix/doc-inconsistencies branch 2 times, most recently from 575ab86 to 2b0bea3 Compare July 14, 2026 19:00
@mesutoezdil

Copy link
Copy Markdown
Contributor Author

Haven Xia (@HavenXia) Doc terminology fixes here, would you mind reviewing when you have time?

Mesut Oezdil (mesutoezdil) added a commit to mesutoezdil/substrate that referenced this pull request Jul 22, 2026
Revert actor_id/actor_uid regression in observability.md per review.
Merge fixes from agent-substrate#349, agent-substrate#359, agent-substrate#323 into this PR.
@mesutoezdil
Mesut Oezdil (mesutoezdil) deleted the fix/doc-inconsistencies branch July 25, 2026 10:22
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