docs(nx-dev): tech intro page structure improvements#34450
docs(nx-dev): tech intro page structure improvements#34450barbados-clemens merged 15 commits intomasterfrom
Conversation
|
View your CI Pipeline Execution ↗ for commit 281817f
☁️ Nx Cloud last updated this comment at |
✅ Deploy Preview for nx-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for nx-dev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
ec6c9da to
f89da7e
Compare
There was a problem hiding this comment.
✅ The fix from Nx Cloud was applied
These changes fix the Markdoc syntax error in the Gradle introduction page by removing blockquote prefixes (>) from the tabitem closing and opening tags. The blockquote syntax was preventing the Markdoc parser from properly recognizing the structural tags, which caused the build to fail with "missing closing" errors.
Tip
✅ We verified this fix by re-running astro-docs:build.
Suggested Fix changes
diff --git a/astro-docs/src/content/docs/technologies/java/gradle/introduction.mdoc b/astro-docs/src/content/docs/technologies/java/gradle/introduction.mdoc
index fb3f1280a3..fa32544789 100644
--- a/astro-docs/src/content/docs/technologies/java/gradle/introduction.mdoc
+++ b/astro-docs/src/content/docs/technologies/java/gradle/introduction.mdoc
@@ -29,9 +29,10 @@ Install Nx with your preferred package manager:
npm install --global nx@latest
```
-> You can use `pnpm`, `yarn`, or `bun` if you prefer as well.
-> {% /tabitem %}
-> {% tabitem label="Homebrew (macOS, Linux)" %}
+You can use `pnpm`, `yarn`, or `bun` if you prefer as well.
+
+{% /tabitem %}
+{% tabitem label="Homebrew (macOS, Linux)" %}
```shell
brew install nx
This fix was applied by Caleb Ukle
🎓 Learn more about Self-Healing CI on nx.dev
astro-docs/src/content/docs/technologies/angular/introduction.mdoc
Outdated
Show resolved
Hide resolved
astro-docs/src/content/docs/technologies/typescript/introduction.mdoc
Outdated
Show resolved
Hide resolved
astro-docs/src/content/docs/technologies/test-tools/jest/introduction.mdoc
Outdated
Show resolved
Hide resolved
4e4f5f5 to
f786761
Compare
astro-docs/src/content/docs/technologies/angular/introduction.mdoc
Outdated
Show resolved
Hide resolved
astro-docs/src/content/docs/technologies/build-tools/vite/introduction.mdoc
Outdated
Show resolved
Hide resolved
astro-docs/src/content/docs/technologies/java/maven/introduction.mdoc
Outdated
Show resolved
Hide resolved
astro-docs/src/content/docs/technologies/react/introduction.mdoc
Outdated
Show resolved
Hide resolved
astro-docs/src/content/docs/technologies/react/introduction.mdoc
Outdated
Show resolved
Hide resolved
astro-docs/src/content/docs/technologies/react/next/introduction.mdoc
Outdated
Show resolved
Hide resolved
astro-docs/src/content/docs/technologies/test-tools/vitest/introduction.mdoc
Outdated
Show resolved
Hide resolved
5fd11fd to
3359292
Compare
astro-docs/src/content/docs/technologies/react/introduction.mdoc
Outdated
Show resolved
Hide resolved
Co-authored-by: barbados-clemens <barbados-clemens@users.noreply.github.com>
Co-authored-by: barbados-clemens <barbados-clemens@users.noreply.github.com>
Co-authored-by: barbados-clemens <barbados-clemens@users.noreply.github.com>
… spec Restructure all three introduction.mdoc pages to follow the DOC-407 technology page spec section order: Opening → Setup → Daily Workflow → Configuration → CI Considerations → What's Next. Key changes: - Plugin-is-optional framing in all openings - "Add to existing workspace" before "Create new" in Setup - Verification steps after plugin installation - React page cross-links to Next.js, Remix, and React Router - Next.js and Remix pages include inferred task configuration, plugin options tables, and exclude/include patterns - Card grid What's Next sections with generators/executors references Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>
48d8a54 to
281817f
Compare
Work on making a tech intro pages more consistent with each other and focus on "answering the 80%" for the given technology. Focusing on - Angular - Maven/Gradle - react - TS - Vite - Vitest/Jest The changes are based around answering the following, where each "category" of page might have a different set of depth for the answer. 1. Why do I want to use this plugin? - Plugins are considered fully optional and are aimed at providing better DX for a technology, such as inferred setup, generators, migrations. - some plugins (like TSC) might have special call outs in some of this, but generally the same for all plugins. 2. How do I use this plugin in my workspace? - also pretty commonly the "same" for all plugins in terms of "setup" - where they differ is mostly for frameworks, e.g. Angular, React. You're looking at setting up a project to use these tools - For Build/Test tools you're looking at adding to an existing project, or converting from one to another. - Build/Test tools are "means to an end", so should callout if the goal is tool + framework in a "new" context point to the framework based plugin page. Otherwise, show adding to an existing project like React project. 3. What do I need to know about using this plugin? - understanding finer details of a plugin options, e.g. buildable & publishable - extra generators for the plugin. e.g. "convert-to-swc" - generally I like the idea of having a "CI considerations" where we talk about CI setups that can help, e.g. options or batch mode etc. closes DOC-407 --------- Co-authored-by: nx-cloud[bot] <71083854+nx-cloud[bot]@users.noreply.github.com> Co-authored-by: barbados-clemens <barbados-clemens@users.noreply.github.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com> (cherry picked from commit 42b5343)
Work on making a tech intro pages more consistent with each other and focus on "answering the 80%" for the given technology.
Focusing on
The changes are based around answering the following, where each "category" of page might have a different set of depth for the answer.
closes DOC-407