Documentation Guide
Guide to using Arc Memory SDK documentation
Documentation Guide
Welcome to the Arc Memory SDK documentation. This guide will help you navigate our documentation to find the information you need quickly and efficiently.
Beta Release: Arc Memory SDK is currently in beta. We’re actively gathering feedback and improving the platform.
How to Use This Documentation
If you’re new to Arc Memory, we recommend following this path:
Read the Introduction
Start with the home page to understand what Arc Memory is and its key features.
Install Arc Memory
Follow the installation guide to set up Arc Memory on your system.
Try the Quick Start
Use the quick start guide to build your first knowledge graph.
Explore Examples
Check out the examples to see real-world usage scenarios.
If you’re new to Arc Memory, we recommend following this path:
Read the Introduction
Start with the home page to understand what Arc Memory is and its key features.
Install Arc Memory
Follow the installation guide to set up Arc Memory on your system.
Try the Quick Start
Use the quick start guide to build your first knowledge graph.
Explore Examples
Check out the examples to see real-world usage scenarios.
If you’re already familiar with Arc Memory:
If you’re experiencing issues:
- Check the common issues section on the home page
- Look for specific troubleshooting tips in the relevant command documentation
- Try the doctor command to diagnose problems
- If all else fails, open an issue on GitHub
Documentation Map
Main Documentation Sections
Getting Started
Begin your journey with Arc Memory:
CLI Reference
Command-line interface documentation:
API Reference
Programmatic interfaces:
Examples
Real-world usage examples:
Architecture & Design
Common Use Cases
Understand code history
Use arc trace file to understand the history and context of specific code:
Find related PRs and issues
Discover the PRs and issues related to specific code changes.
Track architectural decisions
Connect code changes to architectural decisions documented in ADRs.
Understand code history
Use arc trace file to understand the history and context of specific code:
Find related PRs and issues
Discover the PRs and issues related to specific code changes.
Track architectural decisions
Connect code changes to architectural decisions documented in ADRs.
Track team contributions
Analyze contributions across the codebase by team members.
Understand decision history
Trace the history of important architectural decisions.
Onboard new team members
Help new team members understand the codebase history and context.
Integrate with CI/CD
Add Arc Memory to your CI/CD pipeline to keep knowledge graphs up-to-date.
Track deployment history
Connect deployments to code changes and issues.
Automate documentation
Generate documentation based on code history and context.
Documentation Feedback
We’re constantly improving our documentation. If you have suggestions or find issues, please open an issue on GitHub or contribute directly to the documentation repository.