Skip to content

nx-cloudflare: set up a dedicated documentation site #156

Description

@NachoVazquez

Why. nx-cloudflare has no documentation website — everything lives in packages/nx-cloudflare/README.md. The repo already ships a Starlight/Astro docs site for gonx (docs/gonx-docs, deployed to Cloudflare Workers), so the pattern and tooling exist. As the plugin modernizes (#115) and gains generators/executors, a single README is hard to navigate and leaves nowhere to host conceptual guides (config formats, bindings, deploy modes).

Fix. Stand up a docs/nx-cloudflare-docs Starlight site mirroring docs/gonx-docs:

  • Astro + Starlight scaffold, project.json, and a wrangler.jsonc deploy target (same setup as gonx-docs).
  • Sidebar: Quick Start, Generators (application, library), Executors (serve, deploy), and a Configuration section (wrangler.jsonc/toml, $schema, accountId, compatibility date).
  • Migrate the README content into structured pages; keep the README as a concise pointer to the site.
  • Wire it into the docs deploy pipeline alongside gonx-docs.

Effort: L · Impact: Med-High (discoverability, room for guides).

This is the home where doc tasks like the Next.js-removal migration note and the #127 config-format docs should eventually live. Part of #115.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationnx-cloudflareThe @naxodev/nx-cloudflare plugin

    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