Skip to content

Comments

docs: Reorganize documentation structure#160

Merged
abrookins merged 1 commit intomainfrom
docs/reorganize-documentation-structure
Feb 24, 2026
Merged

docs: Reorganize documentation structure#160
abrookins merged 1 commit intomainfrom
docs/reorganize-documentation-structure

Conversation

@abrookins
Copy link
Collaborator

Summary

Reorganizes documentation structure to improve discoverability and separate development concepts from operational concerns.

Changes

New Operations Guide

  • Created operations-guide-index.md as landing page
  • Moved configuration, authentication, security, LLM/embedding providers, vector store backends from Developer Guide

SDK Documentation

  • Python SDK: Complete rewrite with accurate API examples, MemoryClientConfig usage, tool integration, filter reference
  • TypeScript SDK: New documentation (358 lines)
  • Java SDK: New documentation (321 lines)
  • All SDKs now under API Reference → Client SDKs

Cleanup

  • Consolidated AWS Bedrock content into llm-providers.md, deleted duplicate aws-bedrock.md
  • Fixed broken anchor link in langchain-integration.md
  • Updated mkdocs.yml navigation

Navigation Structure

Developer Guide: Memory concepts, integration patterns, LangChain
Operations Guide: Configuration, Auth, Security, Providers
API Reference: REST, MCP, CLI, Client SDKs (Python, TypeScript, Java)

Testing

  • mkdocs build --strict passes
  • All grammarian style checks pass (Excellent ratings)

Notes

  • python-sdk-index.md is now orphaned (not in nav) - can be deleted in follow-up if desired

- Create Operations Guide for deployment/configuration content
- Move auth, security, providers from Developer Guide to Operations
- Consolidate AWS Bedrock into LLM Providers, delete duplicate
- Add TypeScript and Java SDK documentation
- Update Python SDK docs with accurate API examples
- Restructure API Reference to include Client SDKs section
- Fix broken anchor link in LangChain integration docs
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Review completed. No suggestions at this time.

@jit-ci
Copy link

jit-ci bot commented Feb 24, 2026

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

@abrookins abrookins merged commit 6401a86 into main Feb 24, 2026
23 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