Skip to content

docs: improve README onboarding and clarify project scope - #21

Merged
kclaka merged 2 commits into
mainfrom
docs/readme-improvements
Sep 16, 2026
Merged

kclaka merged 2 commits into
mainfrom
docs/readme-improvements

Conversation

@kclaka

@kclaka kclaka commented Sep 16, 2026 •

Copy link
Copy Markdown
Owner

The README omitted steps needed to run the complete demo from source and overstated several unfinished features. This update makes onboarding reproducible and describes the behavior currently merged into main.

  • Put the Docker quick start first and add separate-terminal source setup, cache-hit examples, workload controls, and troubleshooting.
  • Add a Mermaid architecture diagram, configuration and API references, and the supported RESP command subset.
  • Document current HTTP caching and reload behavior, dashboard tests, and remaining comparison, Prometheus, and benchmark limitations. Distinguish the SIEVE paper’s results from this repository’s benchmarks.

Validation: local links and anchors resolve; all 14 shell examples pass Bash syntax checks; example JSON parses; docker compose config --quiet, git diff --check, and GitHub Markdown rendering pass. The conflict with the latest main is resolved, and the resulting PR changes only README.md. Application tests were not rerun for this documentation-only update.

@kclaka
kclaka merged commit 0fd95c8 into main Sep 16, 2026
4 checks passed
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.

1 participant