Skip to content

Move product documentation into the Builder repository #5986

Description

@kof

Problem

Product documentation currently lives in webstudio-is/webstudio-community, separate from the CLI and Builder code that defines documented behavior. Cross-repository MCP documentation synchronization has proven unreliable and requires additional credentials and release coordination.

Desired outcome

Make webstudio-is/webstudio the source repository for all product documentation and retire webstudio-is/webstudio-community after the migrated documentation is published and verified.

Product scope

  • Preserve the current documentation content, navigation, assets, and useful Git history under /docs in the Builder repository.
  • Keep the public docs.webstudio.is URLs stable.
  • Generate and validate MCP documentation entirely within the Builder repository.
  • Publish GitBook from a docs branch that merges the exact revision of each successful release and records its CLI version, so public documentation never leads the installable CLI.
  • Update repository links and automation that refer to the Community repository.
  • Repoint GitBook to the Builder repository.
  • Delete the Community repository only after the Builder-hosted documentation is verified in production.

Constraints

  • GitHub Discussions will not be migrated.
  • Documentation publishing must not depend on a cross-repository token or dispatch.
  • The docs branch is a publication branch and is not edited directly.
  • Existing Builder release and publish paths must remain intact.
  • Preserve a recoverable repository mirror before deletion.

Acceptance criteria

  • Documentation sources and assets are present under Builder /docs with working navigation and internal links.
  • MCP documentation generation and stale-output checks run locally in Builder CI.
  • A successful release merges its immutable tag commit into docs and records the released CLI version only after release creation and package publication succeed.
  • GitBook publishes /docs from Builder's docs branch without changing public documentation URLs.
  • References to Community Discussions or the Community documentation repository are removed or replaced where appropriate.
  • Superseded cross-repository automation is removed.
  • The Community repository is deleted only after production verification.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions