Skip to content

Align README, website and docs around conversational development - #4966

Merged
asim merged 1 commit into
masterfrom
codex/docs-consistency-20260924
Sep 26, 2026
Merged

asim merged 1 commit into
masterfrom
codex/docs-consistency-20260924

Conversation

@asim

@asim asim commented Sep 24, 2026

Copy link
Copy Markdown
Member

The README introduced conversational development while the website and guides still led with greeter scaffolding and conflicting prerequisites. Some gateway references also advertised obsolete default credentials.

Align the landing page, quickstart, getting-started guide and CLI README around chat → generated services → creating a Go agent with service tools. Explain discovery, session lifecycle and the distinction between the CLI development agent and a named agent. Correct v6/Go 1.25 prerequisites, AI package references and gateway authentication defaults; identify the deprecated server alias. Update preflight's minimum Go version and documentation checks to match the current module and onboarding flow. Preserve optional provider-free walkthroughs and the light theme.

Validation: go build ./... and golangci-lint run ./... pass; targeted preflight, CLI documentation and documentation harness tests pass, including compilation of the first-agent tutorial. Hugo production build passes. Internal links resolve on the landing page, docs index, quickstart, getting-started and first-agent pages. git diff --check passes.

The full Go test suite was not rerun because automatic approval review previously rejected tests that contacted Atlas Cloud. CI must pass before merge.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-24T15:14:54.687994Z 7995af1 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 7995af1b03

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +30 to +33
With no registered agents, `micro chat` uses its built-in development agent.
When a capability is missing, it can generate a service in the current directory,
compile and start it, and discover its endpoints as tools. You can then use that
service in the same conversation. The generated Go source is yours to inspect

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Include protobuf tooling in the conversational quick start

On a fresh machine following only the documented Go and micro installation, this path cannot compile and start the generated service: generate.Generate writes a Makefile that invokes protoc --micro_out --go_out, but installing the CLI does not install protoc, protoc-gen-go, or protoc-gen-micro; the failed generation command is ignored and the subsequent build in handleGenerate fails. Either add the protobuf toolchain to these prerequisites or make conversational generation use/install a self-contained scaffold before presenting it as the default quick start.

Useful? React with 👍 / 👎.

@asim
asim merged commit 9e5c1dd into master Sep 26, 2026
8 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant