docs: make quick start prove first memory - #293
Merged
Merged
Conversation
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.
Summary
.env.exampleso source-checkout users can copy a visible config file withcp .env.example .env..env.examplesynchronized with the packagedsrc/everos/templates/env.templatethroughscripts/check_docs.py.QUICKSTART.md, andREADME.zh-CN.mdagainst the current CLI/API contracts.unprocessed_messages, and clarifies that cascade indexing can catch up after the synchronous Markdown write.everos --helpfrom the main success path to reduce friction.README.zh-CN.md, and updatesQUICKSTART.mdwith the copy option.Why
The previous Quick Start got users to a running server, but did not show the first successful product loop. A new developer now sees how to create config, write a memory, search it back, understand why that moment matters, and immediately discover what people are building with persistent memory.
Verification
uv run python <quickstart contract smoke>QUICKSTART.md/README.zh-CN.mdcontain the documented install, config, server, add, flush, and search steps.env.exampleequals the packagedsrc/everos/templates/env.templateeveros init --to <tmp>/.envthrough the Typer CLI and confirms0600permissions/healthoncreate_app(lifespan_providers=[])/searchresponse data arrays, includingunprocessed_messagesuv run everos server start --env-file <tmp> --port <random>health smokegit diff --checkmake docs-checkuv run pytest tests/unit/test_memory/test_search/test_dto.py -vmake test(1211 passed, 1 skipped)