Skip to content

docs: close residual CLAUDE.md/docs/code alignment gaps (summarize guide, telegram dup, connectors) #1339

@kovtcharov-amd

Description

@kovtcharov-amd

Why this matters

#1337 reconciled CLAUDE.md and the CLI reference with the code. A few alignment gaps remain that need content work or product judgment, not a mechanical accuracy fix — tracking them here so they aren't lost.

Gaps

  1. gaia summarize has no user guide. It's a real top-level command (and SummarizerAgent), documented now in the CLI reference, but there's no docs/guides/summarize.mdx and no nav entry. Needs a written guide modeled on the other agent guides.

  2. Duplicate Telegram guide. docs/guides/telegram.mdx ("Telegram Messaging Adapter… v0.18.2 scaffold") and docs/guides/telegram-adapter.mdx ("Telegram Adapter") both exist; only telegram-adapter is in docs/docs.json. telegram.mdx is an orphan and looks like the older copy. Decide which is canonical and remove/redirect the other.

  3. Orphan docs/security/connectors.mdx. Exists but isn't referenced anywhere in docs/docs.json. Either add it to the nav or fold it into the existing connectors/* pages.

  4. gaia connectors subcommands undocumented. The command exists (Google/GitHub OAuth + MCP-server connectors with per-agent grants; gaia connectors mcp add/remove per feat(connectors): custom MCP server support (gaia connectors mcp) #977) but has no CLI-reference section and only a one-line CLAUDE.md mention. Enumerate its subcommands and document them.

  5. gaia mcp subcommand coverage in cli.mdx. cli.py registers serve, tools, and test-client in addition to the documented start/status/stop/test/agent/docker/add/list/remove — audit and fill the gaps.

Acceptance criteria

  • docs/guides/summarize.mdx written and added to docs/docs.json.
  • One canonical Telegram guide; the duplicate removed or redirected; nav consistent.
  • docs/security/connectors.mdx either in nav or merged away (no orphan).
  • gaia connectors and the remaining gaia mcp subcommands documented in docs/reference/cli.mdx.

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions