Skip to content

docs: add markdown documentation structure#61

Merged
rogerchappel merged 1 commit into
mainfrom
chore/docs-markdown-structure
Apr 7, 2026
Merged

docs: add markdown documentation structure#61
rogerchappel merged 1 commit into
mainfrom
chore/docs-markdown-structure

Conversation

@rogerchappel
Copy link
Copy Markdown
Owner

What

Proper docs structure in /docs — plain markdown, no static site generator. Ready to point Mintlify, Starlight, or Nextra at this folder when the time comes.

Structure

docs/
  README.md                          # Index with links to all sections
  getting-started/
    installation.md                  # Quick start, Docker, external Postgres
    configuration.md                 # Environment variables
    authentication.md                # Local auth, GitHub OAuth, API tokens
  concepts/
    agents.md                        # Creating and managing AI agents
    tasks.md                         # Task lifecycle and assignment
    skills.md                        # Installing and configuring skills
    inbox.md                         # Priority notifications and approvals
    team-structure.md                # Org charts, delegation, escalation
  guides/
    deploy-first-team.md             # One-click team templates
    connect-providers.md             # Claude, GPT, Gemini, Ollama
    self-hosting.md                  # Production deploy, HTTPS, backups
    budgets-governance.md            # Spending limits, approval gates, audit
  API.md                             # (existing) Full REST API reference
  architecture/                      # (existing) System design specs
  specs/                             # (existing) Feature specs

Also trashed the empty docs-site/ Astro scaffold (was untracked, 0 committed files).

- docs/README.md — index with links to all sections
- getting-started/ — installation, configuration, authentication
- concepts/ — agents, tasks, skills, inbox, team structure
- guides/ — deploy first team, connect providers, self-hosting, budgets

Plain markdown, no static site generator. Ready to point Mintlify,
Starlight, or Nextra at this folder when the time comes.
@rogerchappel rogerchappel merged commit 88ef556 into main Apr 7, 2026
1 check 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