# YAMS Documentation

Content-addressed storage with deduplication and semantic search.

Site landing: [index.md](index.md) • Project README: [../README.md](../README.md)

## User guide

| Topic             | Link                                             |
|-------------------|--------------------------------------------------|
| Install           | [user_guide/installation.md](user_guide/installation.md) |
| CLI reference     | [user_guide/cli.md](user_guide/cli.md)           |
| MCP server        | [user_guide/mcp.md](user_guide/mcp.md)           |
| Embeddings        | [user_guide/embeddings.md](user_guide/embeddings.md) |
| Tutorials         | [user_guide/tutorials/](user_guide/tutorials/)   |
| Tuning / diagnostics | [user_guide/cli.md](user_guide/cli.md) |
| Plugins           | [PLUGINS.md](PLUGINS.md)                         |
| Build from source | [BUILD.md](BUILD.md)                             |
| Admin / ops       | [admin/operations.md](admin/operations.md)       |
| Hosting           | [hosting/](hosting/)                             |
| Changelog         | [changelogs/](changelogs/)                       |
| Roadmap           | [roadmap.md](roadmap.md)                         |
| Release policy    | [release-policy.md](release-policy.md)           |

## Developer / reference

| Topic               | Link                                           |
|---------------------|------------------------------------------------|
| Architecture        | [architecture/](architecture/)                 |
| API (MCP, plugins)  | [api/](api/)                                   |
| Plugin spec (WIT, schemas) | [spec/](spec/)                          |
| Contributing        | [developer/contributing.md](developer/contributing.md) |
| Build system internals | [developer/build_system.md](developer/build_system.md) |
| Profiling           | [developer/profiling.md](developer/profiling.md) |
| Benchmarks          | [benchmarks/README.md](benchmarks/README.md)   |
| Design docs         | [design/](design/)                             |
| ADRs                | [adrs/](adrs/)                                 |
| RFCs                | [rfcs/](rfcs/)                                 |
| Testing             | [testing/](testing/)                           |
| CI                  | [ci/local-act.md](ci/local-act.md)             |

## External

- SourceHut: https://sr.ht/~trvon/yams/
- GitHub: https://github.com/trvon/yams
- Releases: https://github.com/trvon/yams/releases
- Issues: https://github.com/trvon/yams/issues