docs: take Defang Deploy one layer down from the section landing - #431
Conversation
Follow-on to #430, which named the product only where a sentence defined it. This takes the page titles, descriptions, h1s and first defining sentence of the Deploy section, which is the layer a reader actually sees. A correction to the reasoning in #430 first. That PR left the intro.mdx h1 as "Defang Documentation" on the grounds that it was the docs site root. It is not. The root is a separate custom page, src/pages/index.tsx, serving docs.defang.io with its own title of "Defang". intro.mdx is the Deploy section's own landing, reached from the Defang Deploy navbar tab, so it now reads "Defang Deploy Documentation". Changed, per page: the Overview h1; What is Defang becomes What is Defang Deploy in title, description, h1 and its opening sentence; Features in description, h1 and opening sentence; Use Cases the same; Getting Started's description and its opening claim about not installing anything in your cloud; and the FAQ description. The real site root keeps its "Defang Documentation" h1, because that page does cover both products. Its product sentence and its card now say Defang Deploy, since both describe Deploy specifically. The same card text in getting-started is kept in step with the copy #430 already fixed in intro.mdx. URLs are untouched, including /docs/intro/what-is-defang. Renaming the file would break inbound links for a heading change, and the style guide treats URLs as identifiers rather than copy. All fourteen Defang CLI references in the section are untouched. The CLI keeps its name, so "Install the Defang CLI" and every defang command stay as they are, and nothing became "Defang Deploy CLI". Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
Important Review skippedBot user detected. To trigger a single review, invoke the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Comment |
Three follow-ons from review.
The docs root landing had four cards, all of them Defang Deploy, and never
mentioned Station even though Station has had a docs section since it went into
the navbar. It now carries a Defang Station card next to the Deploy one.
Prakash was right that stopping at the first sentence read oddly. "Defang
Deploy provides a streamlined experience... Defang includes the following
features" sat in one paragraph naming the product two different ways. The
"context has already named it" rule works across sections, not across adjacent
sentences.
So the rule in these top-layer pages is now: a sentence claiming what the
product does or supports says Defang Deploy. Forty mentions across five pages.
References to the CLI, the account and login layer, authentication, the
Discord, the repository, the logo and terminal output stay bare, because those
are company-level or are names that do not change. Thirteen Defang CLI
references are untouched and nothing became "Defang Deploy CLI".
Seven FAQ headings carry the product name, and renaming a heading changes the
anchor Docusaurus derives from it. All seven now pin their original anchor with
an explicit {#id}. Four were still on their original anchors and would have
broken; the other three were changed by #430, so pinning restores the anchors
that had been live for years and repairs that regression.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This site sets markdown.format to "mdx" in docusaurus.config.js, so every .md
is parsed as MDX and `{#id}` is read as a JSX expression. The build failed with
"Could not parse expression with acorn" on questions.md.
A plain <a id="..."></a> before each heading does the same job and parses.
Verified in the built HTML: both the pinned pre-rename anchors and the new
auto-generated ones are present, so old deep links and new ones both resolve.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Three updates from review1. Station is now on the docs landing
2. You were right about "Defang includes the following features"Stopping at the first sentence left one paragraph naming the product two ways:
The "context has already named it" rule works across sections, not across adjacent sentences. Rule tightened:
40 mentions across five pages. Deliberately still bare, because they are company-level or are names that do not change:
Verified: zero instances of 3. Seven FAQ headings would have broken their anchorsDocusaurus derives heading IDs from the text, so renaming a heading changes its anchor and breaks external deep links. All seven now pin their original anchor. This also repairs a regression from #430. Live on production right now: Pinning restores all seven to the anchors that had been live for years.
PreviewThere is no automatic preview for this repo — Worth looking at: the landing (Station card), The link is time-limited — ask and I will mint a fresh one. If a hosted preview per PR would be useful going forward, adding an artifact upload or a preview deploy to BuildFull |
Review feedback: the landing said "Defang Documentation", then described only Defang Deploy underneath it, then offered a mix of Deploy and Station cards. It is now a chooser. The h1 stays, the sentence moves up to the company level, and there are two cards: Defang Deploy and Defang Station. The three Deploy-specific cards leave. CLI Reference and Deploy to your own cloud were already on the Defang Deploy page, so they were duplicates. Agent Skills was not, so it moves there rather than being dropped. That page now carries all four. The section heading becomes Products, since two product cards are a chooser rather than a getting-started list. Forge is deliberately absent: it has no docs section, and a card pointing nowhere is worse than no card. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Landing is now a two-product chooserYou were right on all three points. It said "Defang Documentation", described only Deploy underneath, then offered a mix of Deploy and Station cards. BeforeAfterThe sentence moves up to the company level, so it matches the h1 above it rather than contradicting it. The heading becomes Products, since two product cards are a chooser rather than a getting-started list. Where the other three cards went
The Defang Deploy page now carries all four, which is where a reader who has chosen a product expects them: Forge is deliberately absent. It has no docs section, and a card pointing nowhere is worse than no card. Verified in the built siteRefreshed previewNow served by |
You were seeing a cached copy — here is proof, and a fresh originThe fix is on the branch and in the build. What you clicked was your browser's cached copy of the earlier build, because both preview links pointed at the same host and port. What is actually being served, screenshotted just now in a clean browserTwo cards. Count them. Measured in the same run, from a fresh browser context with no cache: The old sentence you quoted — "Defang Deploy lets you take your app from Docker Compose…" — is gone from the landing. It lives on A different port, so your browser has no cache entry for itOpen the preview on the fresh origin Port 4401 rather than 4400, same build. A new origin means no cache entry, so this cannot show you a stale page. Verified on it directly: If you would rather stay on the old link, a hard reload (Cmd-Shift-R) will do the same job.
The screenshot lives on a separate |

Follow-on to #430, which named the product only where a sentence defined it. This takes the titles, descriptions, h1s and first defining sentence of the Deploy section — the layer a reader actually sees.
A correction to #430's reasoning first
That PR left the
intro.mdxh1 as "Defang Documentation" on the grounds it was the docs site root. It is not. The root is a separate custom page,src/pages/index.tsx, servingdocs.defang.io/with its own title of "Defang":intro.mdxis the Deploy section's own landing, reached from the "Defang Deploy" navbar tab. So it now reads "Defang Deploy Documentation".What changed
intro.mdx)The real site root keeps its
Defang Documentationh1 — that page genuinely does cover both products. Its product sentence and its card now say Defang Deploy, because both describe Deploy specifically. The same card text ingetting-started.mdxis kept in step with the copy #430 already fixed inintro.mdx.What was not touched
/docs/intro/what-is-defang. Renaming the file would break inbound links for the sake of a heading, and the style guide treats URLs as identifiers rather than copy.Defang CLIreferences in the section. The CLI keeps its name, so "Install the Defang CLI" and everydefangcommand stay. Verified: zero instances of "Defang Deploy CLI" were introduced.One thing I'd like your call on
The docs root landing does not mention Station at all. Its four cards are "Learn more about Defang Deploy", "Agent Skills", "CLI Reference", "Deploy to your own cloud" — and Station has had a docs section since it was added to the navbar.
That is the same gap you asked me to close on the AI-facing surfaces in #3266, so I suspect the answer is the same. But it adds a card rather than renaming one, so I left it out and am asking instead. One line if you want it.
Verification
docusaurus.config.jsparsessrc/pages/index.tsxsyntax validDefang CLIreferences intact, 0 wrongly renamedtest-deploybuild green on this PR🤖 Generated with Claude Code