Skip to content

docs: rebuild customer-facing documentation from scratch #240

Description

@moonming

Summary

The current docs/ content is stale and no longer matches the product's real behavior. We should discard the old structure and rebuild the customer-facing documentation from scratch around the current AISIX AI Gateway and AISIX Cloud experience.

This docs set should be organized for two audiences:

  • platform engineers operating and configuring the gateway
  • AI agent developers integrating via OpenAI-compatible and Anthropic-style APIs

Top-level product positioning:

  • AISIX AI Gateway is the primary product
  • AISIX Cloud is the managed control-plane / data-plane extension

Scope

  • Replace the current flat docs structure with a new information architecture
  • Document only currently implemented behavior in the main docs
  • Move not-yet-implemented capabilities into a dedicated docs/roadmap.md
  • Treat old docs as disposable; do not preserve them for backward compatibility

New Docs Structure

  • docs/index.md
  • docs/roadmap.md
  • docs/overview/*
  • docs/quickstart/*
  • docs/integration/*
  • docs/configuration/*
  • docs/cloud/*
  • docs/operations/*
  • docs/reference/*
  • docs/tutorials/*

Sub-issues

Remaining Work Breakdown

  • No page-level gaps remain in the rebuilt docs structure tracked by this parent issue.
  • Remaining follow-up, if any, should be handled as doc refinements or separate behavior-specific issues rather than missing-section rebuild work.

Acceptance Criteria

  • The old docs set is removed or fully superseded
  • The new structure is navigable from docs/index.md
  • Main docs describe only current, verified behavior
  • Planned / not-yet-implemented capabilities are documented only in docs/roadmap.md
  • The docs are written for customer-facing consumption, not as internal implementation notes

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions