Skip to content

docs(misc): replace monolithic tutorials with focused topic-based tutorials#34998

Merged
jaysoo merged 1 commit into
masterfrom
DOC-452
Mar 26, 2026
Merged

docs(misc): replace monolithic tutorials with focused topic-based tutorials#34998
jaysoo merged 1 commit into
masterfrom
DOC-452

Conversation

@jaysoo
Copy link
Copy Markdown
Member

@jaysoo jaysoo commented Mar 24, 2026

Current Behavior

The Tutorials section has three large framework-specific tutorials (React Monorepo, Angular Monorepo, TypeScript Monorepo) that each teach everything at once. They are 500+ lines, tightly coupled to a specific tech stack, and don't build knowledge incrementally.

Expected Behavior

Seven focused, technology-agnostic tutorials that each teach one concept in ~5 minutes. The design follows progressive disclosure so users learn one thing well before moving to the next.

Preview: https://deploy-preview-34998--nx-docs.netlify.app/docs/getting-started/tutorials/crafting-your-workspace

Design goals

  • Learn the basics in an hour: A user going through all 7 tutorials covers workspace structure, dependencies, tasks, running, caching, debugging, and plugins.
  • AI agent friendly: Each page has an llm_copy_prompt at the top that an AI agent can use as a tutor prompt. A user can paste this into Claude Code, Cursor, or any AI tool and be guided through the topic in their own workspace.
  • No assumed workspace state: Each tutorial works whether you used create-nx-workspace, ran nx init on an existing repo, or jumped to a specific topic. Pages link back to prerequisites when needed.
  • One concept per page: Progressive disclosure means plugins aren't mentioned until tutorial 7, nx graph isn't shown until tutorial 6, and caching configuration doesn't appear until tutorial 5.

Tutorial sequence

  1. Crafting your workspace - Nx as a build intelligence layer, workspace structure, package manager workspaces, TypeScript solution-style project references, adding projects
  2. Managing dependencies - Workspace libraries, buildable vs non-buildable (with exports and customConditions), workspace:* protocol, single version policy with catalogs
  3. Configuring tasks - package.json scripts vs project.json targets, dependsOn with ^ syntax, continuous tasks, named configurations, target defaults
  4. Running tasks - nx run, shorthand, run-many with --targets/--projects, task ordering with SVG diagram, parallelism control, passing arguments
  5. Caching tasks - Run-twice demo, computation hashing with SVG diagram, inputs/outputs, named inputs, env vars/runtime inputs, sandboxing, remote caching with nx connect
  6. Understanding your workspace - nx graph as entry point, project graph with edge screenshots, task graph with screenshots, nx show project/nx show target, affected analysis with --base/--head, cache debugging
  7. Reducing configuration boilerplate - targetDefaults, Nx plugins, inferred tasks, nx add, configuration cascade, presented as optional

Other changes

  • CI tutorial rewritten to cover remote caching, affected (with NX_BASE/NX_HEAD), Nx Agents, and self-healing (was previously self-healing only)
  • Concept pages ("How Nx works") link to relevant tutorials via "Learn by doing" callouts
  • Redirects from old tutorial URLs to new pages
  • Cross-references updated across 11 technology/guide pages
  • SVG diagrams for task dependency ordering and cache hash flow (same style as sandboxing page)
  • Screenshots for project graph edge detail and task graph views
  • Sidebar: Tutorials group has "New" badge, collapsed by default

Screenshots

Tutorials topics as ordered in sidebar:

image

AI instructions that can be copied and pasted into Claude Code to act as a tutor:

image

Linking to prev/next tutorials at the bottom of each tutorial topic:

image

For concept pages that are covered by a tutorial, link to the tutorial in Next steps:

image

Related Issue(s)

Fixes DOC-452

@jaysoo jaysoo requested a review from a team as a code owner March 24, 2026 20:47
@jaysoo jaysoo requested a review from FrozenPandaz March 24, 2026 20:47
@netlify
Copy link
Copy Markdown

netlify Bot commented Mar 24, 2026

Deploy Preview for nx-docs ready!

Name Link
🔨 Latest commit f06d411
🔍 Latest deploy log https://app.netlify.com/projects/nx-docs/deploys/69c46911dd2aa6f9a6b89c43
😎 Deploy Preview https://deploy-preview-34998--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
Copy Markdown

netlify Bot commented Mar 24, 2026

Deploy Preview for nx-dev ready!

Name Link
🔨 Latest commit f06d411
🔍 Latest deploy log https://app.netlify.com/projects/nx-dev/deploys/69c467d0ed21950008a70b2c
😎 Deploy Preview https://deploy-preview-34998--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.

@nx-cloud
Copy link
Copy Markdown
Contributor

nx-cloud Bot commented Mar 24, 2026

View your CI Pipeline Execution ↗ for commit f06d411

Command Status Duration Result
nx affected --targets=lint,test,build,e2e,e2e-c... ✅ Succeeded 10m 47s View ↗
nx run-many -t check-imports check-lock-files c... ✅ Succeeded 9s View ↗
nx-cloud record -- pnpm nx conformance:check ✅ Succeeded 8s View ↗
nx build workspace-plugin ✅ Succeeded 2m 18s View ↗
nx-cloud record -- nx format:check ✅ Succeeded 1s View ↗
nx-cloud record -- nx sync:check ✅ Succeeded <1s View ↗

☁️ Nx Cloud last updated this comment at 2026-03-26 00:14:02 UTC

nx-cloud[bot]

This comment was marked as outdated.

@jaysoo jaysoo force-pushed the DOC-452 branch 3 times, most recently from 5a13c4b to e0d60cd Compare March 25, 2026 01:26
nx-cloud[bot]

This comment was marked as outdated.

@jaysoo jaysoo force-pushed the DOC-452 branch 6 times, most recently from a7dfc8a to e20e994 Compare March 25, 2026 02:55
nx-cloud[bot]

This comment was marked as outdated.

@jaysoo jaysoo force-pushed the DOC-452 branch 7 times, most recently from 1b5b01c to 49981c6 Compare March 25, 2026 03:57
nx-cloud[bot]

This comment was marked as outdated.

@jaysoo jaysoo force-pushed the DOC-452 branch 3 times, most recently from d5318a1 to b117f7b Compare March 25, 2026 12:22
@jaysoo jaysoo force-pushed the DOC-452 branch 5 times, most recently from fd282d9 to 21739a2 Compare March 25, 2026 14:25
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.

@jaysoo jaysoo force-pushed the DOC-452 branch 2 times, most recently from 92325dd to d0d4636 Compare March 25, 2026 19:09
@jaysoo jaysoo force-pushed the DOC-452 branch 4 times, most recently from 2f8d564 to b3e859b Compare March 25, 2026 20:02
nx-cloud[bot]

This comment was marked as outdated.

nx-cloud[bot]

This comment was marked as outdated.

Comment thread astro-docs/src/content/docs/getting-started/Tutorials/caching.mdoc
…orials

The Tutorials section has three large framework-specific tutorials (React
Monorepo, Angular Monorepo, TypeScript Monorepo) that each try to teach
everything at once. They are ~500+ lines each, tightly coupled to a
specific tech stack, and don't build knowledge incrementally.

Seven focused, technology-agnostic tutorial pages that each teach one
concept in ~5 minutes. Users can go through all topics in about an hour
to learn the basics, or jump to a specific topic they need.

The tutorials follow progressive disclosure:
1. Crafting your workspace - structure, package managers, TypeScript setup
2. Managing dependencies - workspace libraries, buildable vs non-buildable,
   single version policy, catalogs
3. Configuring tasks - package.json/project.json, dependsOn, continuous
   tasks, configurations
4. Running tasks - nx run, run-many, parallelism, passing arguments
5. Caching tasks - computation hashing, inputs/outputs, named inputs,
   remote caching, sandboxing
6. Understanding your workspace - nx graph, project details, task graph,
   affected analysis, debugging
7. Reducing configuration boilerplate - targetDefaults, plugins, inferred
   tasks, configuration cascade

Each page includes:
- An `llm_copy_prompt` for AI agents to act as tutors
- Prev/next navigation cards
- Links back to prerequisites for users who jump in mid-sequence
- Links to deeper reference/concept docs for further reading
- SVG diagrams for task ordering and cache hashing
- Screenshots for project graph edges and task graph views

The CI tutorial is also updated to cover remote caching, affected,
distributed execution, and self-healing (was previously self-healing only).

Concept pages under "How Nx works" now link to relevant tutorials via
"Learn by doing" callouts.

Related Issue(s)

Fixes DOC-452
nx-cloud[bot]

This comment was marked as outdated.

Copy link
Copy Markdown
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.

Important

At least one additional CI pipeline execution has run since the conclusion below was written and it may no longer be applicable.

Nx Cloud has identified a possible root cause for your failed CI:

We determined this failure is an environment state issue unrelated to the PR's changes. The create-nx-plugin:build-base task failed because create-nx-workspace build outputs (declaration files) were missing when it ran — a CI dependency-ordering problem, not caused by any source code modification in this documentation-only PR.

No code changes were suggested for this issue.

Trigger a rerun:

Rerun CI

Nx Cloud View detailed reasoning on Nx Cloud ↗

🔔 Heads up, your workspace has pending recommendations ↗ to auto-apply fixes for similar failures.


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

@jaysoo jaysoo merged commit a1dee72 into master Mar 26, 2026
26 of 28 checks passed
@jaysoo jaysoo deleted the DOC-452 branch March 26, 2026 00:30
FrozenPandaz pushed a commit that referenced this pull request Mar 26, 2026
…orials (#34998)

## Current Behavior

The Tutorials section has three large framework-specific tutorials
(React Monorepo, Angular Monorepo, TypeScript Monorepo) that each teach
everything at once. They are 500+ lines, tightly coupled to a specific
tech stack, and don't build knowledge incrementally.

## Expected Behavior

Seven focused, technology-agnostic tutorials that each teach one concept
in ~5 minutes. The design follows progressive disclosure so users learn
one thing well before moving to the next.

Preview:
https://deploy-preview-34998--nx-docs.netlify.app/docs/getting-started/tutorials/crafting-your-workspace

### Design goals

- **Learn the basics in an hour**: A user going through all 7 tutorials
covers workspace structure, dependencies, tasks, running, caching,
debugging, and plugins.
- **AI agent friendly**: Each page has an `llm_copy_prompt` at the top
that an AI agent can use as a tutor prompt. A user can paste this into
Claude Code, Cursor, or any AI tool and be guided through the topic in
their own workspace.
- **No assumed workspace state**: Each tutorial works whether you used
`create-nx-workspace`, ran `nx init` on an existing repo, or jumped to a
specific topic. Pages link back to prerequisites when needed.
- **One concept per page**: Progressive disclosure means plugins aren't
mentioned until tutorial 7, `nx graph` isn't shown until tutorial 6, and
caching configuration doesn't appear until tutorial 5.

### Tutorial sequence

1. **Crafting your workspace** - Nx as a build intelligence layer,
workspace structure, package manager workspaces, TypeScript
solution-style project references, adding projects
2. **Managing dependencies** - Workspace libraries, buildable vs
non-buildable (with `exports` and `customConditions`), `workspace:*`
protocol, single version policy with catalogs
3. **Configuring tasks** - `package.json` scripts vs `project.json`
targets, `dependsOn` with `^` syntax, continuous tasks, named
configurations, target defaults
4. **Running tasks** - `nx run`, shorthand, `run-many` with
`--targets`/`--projects`, task ordering with SVG diagram, parallelism
control, passing arguments
5. **Caching tasks** - Run-twice demo, computation hashing with SVG
diagram, inputs/outputs, named inputs, env vars/runtime inputs,
sandboxing, remote caching with `nx connect`
6. **Understanding your workspace** - `nx graph` as entry point, project
graph with edge screenshots, task graph with screenshots, `nx show
project`/`nx show target`, affected analysis with `--base`/`--head`,
cache debugging
7. **Reducing configuration boilerplate** - `targetDefaults`, Nx
plugins, inferred tasks, `nx add`, configuration cascade, presented as
optional

### Other changes

- **CI tutorial rewritten** to cover remote caching, affected (with
`NX_BASE`/`NX_HEAD`), Nx Agents, and self-healing (was previously
self-healing only)
- **Concept pages** ("How Nx works") link to relevant tutorials via
"Learn by doing" callouts
- **Redirects** from old tutorial URLs to new pages
- **Cross-references** updated across 11 technology/guide pages
- **SVG diagrams** for task dependency ordering and cache hash flow
(same style as sandboxing page)
- **Screenshots** for project graph edge detail and task graph views
- **Sidebar**: Tutorials group has "New" badge, collapsed by default

## Screenshots

Tutorials topics as ordered in sidebar:

<img width="324" height="290" alt="image"
src="https://github.com/user-attachments/assets/87b27e6a-30f6-4c9b-b52d-b371f66e72e8"
/>

AI instructions that can be copied and pasted into Claude Code to act as
a tutor:

<img width="803" height="308" alt="image"
src="https://github.com/user-attachments/assets/2dcf402e-19a6-4cf4-bcac-7005491529bf"
/>

Linking to prev/next tutorials at the bottom of each tutorial topic:

<img width="871" height="457" alt="image"
src="https://github.com/user-attachments/assets/b9a198b5-edc7-4afd-8c13-fd70c10cf858"
/>

For concept pages that are covered by a tutorial, link to the tutorial
in `Next steps`:

<img width="945" height="435" alt="image"
src="https://github.com/user-attachments/assets/a05d1c0b-c95a-42c5-baec-1fb30dff7c64"
/>

## Related Issue(s)

Fixes DOC-452

(cherry picked from commit a1dee72)
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 1, 2026

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Apr 1, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants