Skip to content

docs: write user guides and tutorials #293

@Aureliolo

Description

@Aureliolo

Summary

Write comprehensive user-facing documentation for SynthOrg. The docs infrastructure (MkDocs + Material + mkdocstrings) is set up — this issue covers the hand-written content.

Guides to Write

  • Quickstart Tutorial — 5-minute guide to running your first synthetic org
  • Company YAML Configuration Reference — complete reference for all config options
  • Agent Roles & Hierarchy — defining agents, roles, reporting structure
  • Budget & Cost Control — per-agent budgets, auto-downgrade, spending reports
  • Security & Trust Policies — trust strategies, autonomy levels, approval gates
  • Tool Integration (MCP) — connecting external tools via MCP bridge
  • Deployment Guide (Docker) — running SynthOrg in production with Docker
  • Memory Configuration — per-agent memory, shared org memory, retrieval pipeline
  • Contributing Guide — development workflow, testing, code conventions

Notes

  • Add guides under docs/guides/ and update mkdocs.yml nav
  • Use admonitions, tabs, and code examples per MkDocs Material features
  • Each guide should be self-contained with a clear goal
  • See ADR-003 for documentation architecture decisions

Metadata

Metadata

Assignees

No one assigned

    Labels

    prio:lowNice to have, can deferscope:large3+ days of worktype:docsDocumentation workv0.5Minor version v0.5v0.5.4Patch release v0.5.4

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions