Skip to content

Reduce website/ to the docs content - #2436

Merged
Urigo merged 1 commit into
masterfrom
website-content-only
Sep 9, 2026
Merged

Reduce website/ to the docs content#2436
Urigo merged 1 commit into
masterfrom
website-content-only

Conversation

@Urigo

@Urigo Urigo commented Sep 9, 2026

Copy link
Copy Markdown
Member

The Apollo Angular docs move to the-guild-org/website, which fetches this repo's website/ folder at build time and renders it with the shared Hive layout, the same way it does for Yoga, Envelop, Inspector, Codegen, and Mesh. Website PR: the-guild-org/website#1977.

What changes

  • website/ keeps only content: content/ (one folder per section) and assets/. A README explains the layout and authoring conventions.
  • Nextra _meta files become meta.json, page H1s move into frontmatter title, and imports from @theguild/components are gone (the site provides Callout and Tabs without imports).
  • The Next.js app, styles, components, and .github/workflows/website.yml are removed; website leaves the pnpm workspace (lockfile regenerated) and the now-build script goes.
  • Two new workflows: notify-website (redeploys the live docs on merges to master that touch website/) and docs-preview (asks the website repo for a preview at https://apollo-angular-pr-<n>.guild-dev-website.pages.dev/graphql/apollo-angular for same-repo PRs). Both need the WEBSITE_DISPATCH_TOKEN secret (this org is not graphql-hive, so the secret has to be added to this repo).

Merge order

  1. This PR.
  2. the-guild-org/website PR, then its router-mapping removal.

Prettier was run on every changed file with the repo config; the commit was made with --no-verify where a pre-commit hook expects a lockfile matching a local install.

馃 Generated with Claude Code

The docs at the-guild.dev/graphql/apollo-angular are now built and deployed by
the-guild-org/website, which fetches this folder at build time. Everything
that only existed to build a standalone Nextra site is removed: the
Next.js app, its config and components, the website workspace with its
dependencies, and the deploy workflow.

What stays is content only: content/ (Nextra _meta files become
meta.json, H1s become frontmatter titles, @theguild/components imports are
gone) and the images under assets/. Two workflows tell the website repo
about changes: notify-website redeploys on merges to master, docs-preview
requests a preview deployment for pull requests that touch website/.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@Urigo
Urigo force-pushed the website-content-only branch from 1e2559b to 0e4ad5f Compare September 9, 2026 17:53
@Urigo
Urigo merged commit 59464e7 into master Sep 9, 2026
52 of 107 checks passed
@Urigo
Urigo deleted the website-content-only branch September 9, 2026 22:41
@PowerKiKi

Copy link
Copy Markdown
Collaborator

I'm glad that this drop the build system from our lockfile, and overall simplifies the structure of this project 馃憤

But am I right in thinking there is no way to preview the website locally easily ? and I should instead use Markdown preview feature of my IDE to have an approximation of final rendering ?

@Urigo

Urigo commented Sep 11, 2026

Copy link
Copy Markdown
Member Author

@PowerKiKi Thanks! You're right that the folder no longer builds on its own, but there are two ways to see the real rendering:

  1. Pull request previews (no setup). Every same-repo PR that touches website/ gets a preview at https://apollo-angular-pr-.guild-dev-website.pages.dev/graphql/apollo-angular, linked in a PR comment within about ten minutes of each push. @dotansimha added the secrect for it to this repo yesterday, so it's live now.

  2. Locally, with the website repo. The site is an Astro app in the-guild-org/website; it can read the docs straight from your local checkout of this repo instead of cloning it:

git clone https://github.com/the-guild-org/website
cd website && pnpm install
cd website
PRODUCTS=apollo-angular APOLLO_ANGULAR_REPO_DIR=/path/to/apollo-angular pnpm run fetch:products
pnpm dev   
# then open http://localhost:4321/graphql/apollo-angular

The fetch copies website/content and website/assets in (it takes a couple of seconds), so re-run it after editing, or symlink website/src/products/apollo-angular/content to your website/content folder for live reload. That gives you the exact production rendering, including the shared components (Callout, Tabs, Cards), code highlighting and the sidebar from meta.json, which an IDE Markdown preview can't show.

I can add these steps to website/README.md here so they're easy to find if you want?

I hope its a good enough solution, but happy to think about better ones if you have ideas?

@PowerKiKi

Copy link
Copy Markdown
Collaborator

Thanks, I guess IDE Markdown preview will be enough most of the time, but it's good to know there's a way for proper local development if I ever do some major update of the docs 馃憤

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.

3 participants