Improve XMTP agent getting started guide with logical flow #610
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.
What changed? Why?
This PR improves the Getting started with Chat Agents guide by restructuring it with a clear, logical flow that prevents confusion.
The Problem
The current documentation jumps between concepts without a clear workflow:
.envmanually but doesn’t explain how to get the values (XMTP_WALLET_KEY,XMTP_DB_ENCRYPTION_KEY)dotenv/config, which causesXMTP_WALLET_KEYformat errorsThe Solution
Restructured the guide with a clear 6-step workflow:
npm run gen:keys— Automatically creates.envwith all required valuesindex.tsfile — Clear instruction on where to put the codedotenv/configlinenpx tsx --watch index.tsNotes to reviewers
The new flow follows the natural developer journey:
setup workspace → generate credentials → write code → run → test.
This eliminates the confusion of “where do I put this?” and “how do I get these values?” that plagued the previous version.
How has it been tested?
Spun up documentation locally with
mint devTested locally and amde sure the agents runs and responds with
Hello from my Base App Agent! 👋