docs: fix drift in Docker Deployment - #257
Draft
jack-arturo wants to merge 1 commit into
Draft
Conversation
The service-architecture diagram labeled the Flask API container "memory-service", but docker-compose.yml on automem@main names the service flask-api — matching the service table lower on the same page. Verified against verygoodplugins/automem@dbb933f (latest commit touching docker-compose.yml/Makefile): all other claims on this page (service images/ports, volumes, env var defaults, health checks, make targets) still match current source.
Deploying automem-website with
|
| Latest commit: |
d6c5ae2
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://1bad778d.automem-website.pages.dev |
| Branch Preview URL: | https://docs-audit-deployment-docker-twz8.automem-website.pages.dev |
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
2 participants
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.
Routine docs-accuracy audit of
src/content/docs/docs/deployment/docker.mdagainstverygoodplugins/automem@main.memory-servicedocker-compose.ymlnames the serviceflask-api— and the doc's own "Service Details" table (a few lines above the diagram) already calls itflask-apiflask-apifor internal consistencyEverything else on the page (service images/ports, volume mounts,
REDIS_ARGS/FALKORDB_DATA_PATHpersistence config, environment variable defaults, FalkorDB health check cadence,depends_onconditions, and the five documentedmaketargets) still matches currentdocker-compose.yml/Makefile— no further changes made.Open question (not fixed, flagging per audit guidelines): the doc describes the FalkorDB health check as simply
redis-cli ping. The actual check is a conditional wrapper (if [ -n "$REDIS_PASSWORD" ]; then redis-cli -a "$REDIS_PASSWORD" ping; else redis-cli ping; fi). SinceREDIS_PASSWORD/FALKORDB_PASSWORDare empty by default and this doc's own env-var table already documentsFALKORDB_PASSWORDas empty-by-default, the simplified description matches the documented default case — leaving as-is unless a maintainer wants the auth-aware branch spelled out.Verified against: verygoodplugins/automem@dbb933f (
docker-compose.yml,Makefile)Same audit run also reviewed
cli/platform-installers.md(verified againstverygoodplugins/mcp-automem@946f9e5) anddevelopment/changelog.md(verified against tags/npm registry of both repos) — both accurate against current source, no PR needed for either.Generated by Claude Code