docs: fix typos, stale content, and port inconsistencies#2144
Open
mesutoezdil wants to merge 1 commit into
Open
docs: fix typos, stale content, and port inconsistencies#2144mesutoezdil wants to merge 1 commit into
mesutoezdil wants to merge 1 commit into
Conversation
mesutoezdil
requested review from
EItanya,
ilackarms,
iplay88keys,
jmhbh,
peterj,
supreme-gg-gg and
yuval-k
as code owners
github-actions
Bot
added
the
documentation
mesutoezdil
force-pushed
the
docs/fix-typos-and-stale-content
branch
2 times, most recently
from
2854a56 to
107ec3c
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates repository documentation to correct typos and stale instructions, and to align examples/commands (notably UI port-forwarding and provider configuration) across docs.
Changes:
- Standardizes UI access instructions (port-forward to
localhost:3000) and removes stale CRD fields in examples. - Updates provider/key documentation (e.g., Azure OpenAI variable naming, provider-agnostic Python prereqs).
- Cleans up and modernizes lifecycle/development docs (step numbering, removed draft notes, corrected behavior description).
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
ui/README.md |
Fixes CLI command name in the UI README header. |
python/README.md |
Makes prerequisites provider-agnostic (not OpenAI-only). |
helm/README.md |
Updates Azure OpenAI examples/env var naming and placeholders. |
examples/substrate-openclaw/README.md |
Removes stale runtime: substrate field and aligns UI port-forward/gateway URL examples. |
docs/substrate-agentharness-lifecycle.md |
Removes draft note and updates reconcile step to reflect actor creation behavior. |
DEVELOPMENT.md |
Updates Go version, fixes step numbering, and aligns UI port-forward instructions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
mesutoezdil
force-pushed
the
docs/fix-typos-and-stale-content
branch
from
be3344c to
93f7d07
Compare
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
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.
Fix several doc issues found across the repo.
DEVELOPMENT.md: Go versionv1.26.1+tov1.26.3+(matches go.mod); fix duplicate step numbers 1-5; fix UI port8001to3000helm/README.md: wrong Azure env var names (AZUREOPENAI_API_KEY,AZURE_API_KEY) toAZURE_OPENAI_API_KEY; fix copy-paste placeholder in Azure helm install exampleexamples/substrate-openclaw/README.md: remove staleruntime: substratefield (not in CRD); fix UI port8001to3000docs/substrate-agentharness-lifecycle.md: remove draft PR note "This branch should use..."; update step 5 to reflect that actors are created on demand by the HTTP gateway, not the controllerui/README.md:kagents uitokagent uipython/README.md: replace hardcodedOpenAI API keyprerequisite with provider-agnostic wording