Skip to content

docs: update README with current architecture, API reference, and deployment guide#24

Merged
SparkZou merged 2 commits intomainfrom
docs/update-readme
Mar 19, 2026
Merged

docs: update README with current architecture, API reference, and deployment guide#24
SparkZou merged 2 commits intomainfrom
docs/update-readme

Conversation

@SparkZou
Copy link
Copy Markdown
Contributor

Summary

Update README.md to reflect the current software architecture and features.

Changes

  • Added Architecture section — ASCII diagram showing API Server + Temporal Worker + PostgreSQL topology, component table, and async /memorize flow explanation
  • Added full API Reference — Documentation for all 6 endpoints (GET /, POST /memorize, GET /memorize/status/{task_id}, POST /retrieve, POST /clear, POST /categories) with request/response examples
  • Added Environment Variables table — All 16 configuration variables with defaults
  • Added Makefile Commands — Quick reference for all make targets
  • Added Integration Guide — Python and cURL examples showing memorize → poll → retrieve workflow
  • Updated Get Started — Restructured into 3 clear steps: start infrastructure, run from source (including worker), run with Docker
  • Updated Key Features — Replaced planned/placeholder features with actual implemented capabilities (async Temporal, status tracking, clear, categories)
  • Preserved — "Why MemU?" core algorithm section, License, and Community sections unchanged

Copilot AI review requested due to automatic review settings March 19, 2026 20:59
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates README.md to reflect the current memU-server architecture and provide a fuller end-to-end usage guide aligned with the FastAPI + Temporal + Postgres setup in this repo.

Changes:

  • Added an Architecture section explaining the API server/worker split and the async /memorize Temporal flow.
  • Expanded “Get Started” with source + Docker instructions, environment variables, and Makefile target quick reference.
  • Added an API reference and an integration walkthrough (Python + cURL) for memorize → poll → retrieve.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md
Comment thread README.md Outdated
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@SparkZou SparkZou merged commit 1707171 into main Mar 19, 2026
5 checks passed
@SparkZou SparkZou deleted the docs/update-readme branch March 19, 2026 21:23
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.

2 participants