Skip to content

docs(open_source_api): add EN translation of all open-source REST API docs#431

Open
CaralHsi wants to merge 1 commit intoMemTensor:v2from
CaralHsi:docs/open-source-api-en-20260323
Open

docs(open_source_api): add EN translation of all open-source REST API docs#431
CaralHsi wants to merge 1 commit intoMemTensor:v2from
CaralHsi:docs/open-source-api-en-20260323

Conversation

@CaralHsi
Copy link
Copy Markdown
Collaborator

Summary

  • 15 new pages: Full English translation of the open-source REST API documentation section, previously available only in Chinese
  • Categories covered:
    • Start (2 files): Overview, Configuration
    • Core (5 files): Add Memory, Search Memory, Delete Memory, Get Memories, Get Memory Detail
    • Chat (1 file): Chat (complete + stream)
    • Message (3 files): Feedback, Get Message, Get Suggestions
    • Scheduler (1 file): Task Status & Queue Monitoring
    • Tools (2 files): Check Cube Existence, Get User Names
    • Help (1 file): Error Codes
  • Adds full navigation section in EN settings.yml

Verification

  • All endpoint paths verified against server_router.py route definitions (e.g., POST /product/add, POST /product/search, GET /product/get_memory/{memory_id}, GET /product/scheduler/status)
  • Parameter tables cross-checked with product_models.py Pydantic model fields (APIADDRequest, APISearchRequest, ChatRequest, APIFeedbackRequest, DeleteMemoryRequest, etc.)
  • Handler orchestration descriptions verified against actual handler classes (AddHandler, SearchHandler, ChatHandler, FeedbackHandler)
  • SDK code examples verified against MemOSClient method signatures

Test plan

  • Verify all 15 pages render correctly on the documentation site
  • Confirm all navigation links resolve properly in the EN sidebar
  • Spot-check 2-3 parameter tables against latest main branch Pydantic models
  • Verify internal cross-links between pages (e.g., Add Memory → Search Memory)

Made with Cursor

… docs

Translate 15 CN-only documentation pages covering the full open-source
REST API surface: core operations (add/search/delete/get memory),
chat, message (feedback/get_message/suggestions), scheduler status,
tools (check_cube/get_user_names), and error codes.

Add navigation section in EN settings.yml.

Made-with: Cursor
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