Skip to content

Reduce website/ to the docs content - #1870

Open
Urigo wants to merge 5 commits into
masterfrom
website-content-only
Open

Urigo wants to merge 5 commits into
masterfrom
website-content-only

Conversation

@Urigo

@Urigo Urigo commented Sep 9, 2026

Copy link
Copy Markdown
Collaborator

The Schema Stitching 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#1982.

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 yarn workspaces (lockfile regenerated).
  • 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://stitching-pr-<n>.guild-dev-website.pages.dev/graphql/stitching 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

@ardatan ardatan left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall direction looks good (content-only website/, notify/preview workflows match the registry pattern). A few content fixes before merge, verified against the live site which already pulls this branch via contentRef.

Also after merge: drop the TEMPORARY contentRef: website-content-only in the-guild-org/website website/src/products/stitching/product.ts, otherwise prod stays pinned to this branch.

Comment thread website/content/handbook/architecture/public-and-private-apis.mdx Outdated
Comment thread website/content/handbook/foundation/mutations-and-subscriptions.mdx Outdated
Comment thread website/content/docs/transforms/custom-transforms.mdx Outdated
Comment thread website/README.md Outdated
@Urigo
Urigo force-pushed the website-content-only branch from 20c86f2 to 3da34bb Compare September 11, 2026 23:45
@github-actions

Copy link
Copy Markdown

馃摉 Docs preview (rebuilds on every push, ready ~10 min after each): https://stitching-pr-1870.guild-dev-website.pages.dev/graphql/stitching

@Urigo
Urigo force-pushed the website-content-only branch from 8bcd169 to 3da34bb Compare September 11, 2026 23:46
@Urigo

Urigo commented Sep 11, 2026

Copy link
Copy Markdown
Collaborator Author

Addressed all four comments in 3da34bb and rebased on master (yarn.lock regenerated on top of it). After this merges I drop the TEMPORARY contentRef on the website side, as you noted.

---

```mermaid
flowchart TD

@ardatan ardatan Sep 11, 2026

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image mermaid graphs don't seem to be rendered correctly

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Urigo I just noticed this ^^

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, good catch. The content is right (it is a plain ```mermaid fence); the website was only running its mermaid plugin for Hive, Yoga and Mesh content, not for the registry products. Fixed on the website side in the-guild-org/website#2017, verified on a local build: the diagram renders in light and dark mode, inline client icon included. It will show up on the live and preview pages once that merges.

Also rebased this branch on master (only yarn.lock and the deleted website/package.json conflicted) and regenerated the lockfile, so it is mergeable again.

@ardatan ardatan Sep 20, 2026

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still seeing the plain text here without a mermaid graph rendered.
https://stitching-pr-1870.guild-dev-website.pages.dev/graphql/stitching/docs

@ardatan ardatan left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-checked after your follow-ups: frontmatter ampersands, the custom-transforms title, and the README wording all look good. Thanks!

Reminder after merge: drop the TEMPORARY contentRef: 'website-content-only' in the-guild-org/website website/src/products/stitching/product.ts.

Urigo and others added 5 commits September 19, 2026 22:51
The docs at the-guild.dev/graphql/stitching 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>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Those packages moved to graphql-hive/gateway and are no longer in the
graphql-tools API reference (the-guild-org/website#1844, #1865).

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

This branch has not been deployed

No deployments
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.

2 participants