Skip to content

Comments

docs(nx-dev): tech intro page structure improvements#34450

Merged
barbados-clemens merged 15 commits intomasterfrom
cu/tech-doc-page-eval
Feb 18, 2026
Merged

docs(nx-dev): tech intro page structure improvements#34450
barbados-clemens merged 15 commits intomasterfrom
cu/tech-doc-page-eval

Conversation

@barbados-clemens
Copy link
Contributor

@barbados-clemens barbados-clemens commented Feb 13, 2026

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
  • 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.
  1. 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.
  1. 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

@nx-cloud
Copy link
Contributor

nx-cloud bot commented Feb 13, 2026

View your CI Pipeline Execution ↗ for commit 281817f

Command Status Duration Result
nx affected --targets=lint,test,test-kt,build,e... ✅ Succeeded 6m 23s View ↗
nx run-many -t check-imports check-lock-files c... ✅ Succeeded 4m 3s View ↗
nx-cloud record -- nx-cloud conformance:check ✅ Succeeded 8s View ↗
nx-cloud record -- nx sync:check ✅ Succeeded <1s View ↗
nx-cloud record -- nx format:check ✅ Succeeded <1s View ↗

☁️ Nx Cloud last updated this comment at 2026-02-18 22:25:04 UTC

@netlify
Copy link

netlify bot commented Feb 13, 2026

Deploy Preview for nx-docs ready!

Name Link
🔨 Latest commit 281817f
🔍 Latest deploy log https://app.netlify.com/projects/nx-docs/deploys/69963924be8e4e0008358e6b
😎 Deploy Preview https://deploy-preview-34450--nx-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link

netlify bot commented Feb 13, 2026

Deploy Preview for nx-dev ready!

Name Link
🔨 Latest commit 281817f
🔍 Latest deploy log https://app.netlify.com/projects/nx-dev/deploys/6996392437321d0008b4d34c
😎 Deploy Preview https://deploy-preview-34450--nx-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@barbados-clemens barbados-clemens force-pushed the cu/tech-doc-page-eval branch 3 times, most recently from ec6c9da to f89da7e Compare February 13, 2026 21:24
nx-cloud[bot]

This comment was marked as outdated.

nx-cloud[bot]

This comment was marked as outdated.

nx-cloud[bot]

This comment was marked as outdated.

Copy link
Contributor

@nx-cloud nx-cloud bot left a comment

Choose a reason for hiding this comment

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

✅ 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

Revert fix via Nx Cloud  

View interactive diff ↗
This fix was applied by Caleb Ukle

🎓 Learn more about Self-Healing CI on nx.dev

@barbados-clemens barbados-clemens marked this pull request as ready for review February 17, 2026 14:30
@barbados-clemens barbados-clemens requested a review from a team as a code owner February 17, 2026 14:30
@barbados-clemens barbados-clemens force-pushed the cu/tech-doc-page-eval branch 2 times, most recently from 5fd11fd to 3359292 Compare February 18, 2026 15:55
@barbados-clemens barbados-clemens enabled auto-merge (squash) February 18, 2026 22:00
barbados-clemens and others added 15 commits February 18, 2026 16:11
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>
@barbados-clemens barbados-clemens merged commit 42b5343 into master Feb 18, 2026
23 of 24 checks passed
@barbados-clemens barbados-clemens deleted the cu/tech-doc-page-eval branch February 18, 2026 22:25
FrozenPandaz pushed a commit that referenced this pull request Feb 20, 2026
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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants