miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 6 Packages Projects Releases Wiki Activity
15,120 Commits 1 Branch 0 Tags
Commit Graph

55 Commits

Author SHA1 Message Date
Jack Hsu
84796d011e
docs(misc): add titles to intro/overview pages (#31636) 
## Current Behavior

- Documentation pages under "technologies" and "core-api" sections with
"introduction"/"overview" IDs lack H1 titles after front matter
- Some remote caching package links point to parent sections instead of
overview pages

## Expected Behavior

- All affected documentation pages should have H1 titles for consistency
- Links should point directly to overview pages

## Related Issue(s)

Fixes #

## Changes Made

### 1. Updated Remote Caching Links (commit fae9055f8c)

Updated links in 3 files to point directly to overview pages:
- `docs/blog/2025-01-06-nx-update-20-3.md`
- `docs/shared/deprecated/custom-tasks-runner.md`
- `docs/shared/recipes/running-tasks/self-hosted-caching.md`

Changed links from:
- `/reference/core-api/azure-cache` →
`/reference/core-api/azure-cache/overview`
- `/reference/core-api/gcs-cache` →
`/reference/core-api/gcs-cache/overview`
- `/reference/core-api/s3-cache` →
`/reference/core-api/s3-cache/overview`
- `/reference/core-api/shared-fs-cache` →
`/reference/core-api/shared-fs-cache/overview`

### 2. Added H1 Titles to Documentation Pages

Added H1 titles to 29 documentation files that were missing them:

#### Core API Overview Pages (6 files)
- `docs/shared/packages/azure-cache/azure-cache-plugin.md` → `#
@nx/azure-cache`
- `docs/shared/packages/conformance/conformance-plugin.md` → `#
@nx/conformance`
- `docs/shared/packages/gcs-cache/gcs-cache-plugin.md` → `#
@nx/gcs-cache`
- `docs/shared/packages/owners/owners-plugin.md` → `# @nx/owners`
- `docs/shared/packages/s3-cache/s3-cache-plugin.md` → `# @nx/s3-cache`
- `docs/shared/packages/shared-fs-cache/shared-fs-cache-plugin.md` → `#
@nx/shared-fs-cache`

#### Technology Introduction Pages (23 files)
- `docs/shared/packages/angular/angular-plugin.md` → `# @nx/angular`
- `docs/shared/packages/esbuild/esbuild-plugin.md` → `# @nx/esbuild`
- `docs/shared/packages/rspack/rspack-plugin.md` → `# @nx/rspack`
- `docs/shared/packages/vite/vite-plugin.md` → `# @nx/vite`
- `docs/shared/packages/webpack/plugin-overview.md` → `# @nx/webpack`
- `docs/shared/packages/eslint/eslint.md` → `# @nx/eslint`
- `docs/shared/packages/gradle/gradle-plugin.md` → `# @nx/gradle`
- `docs/shared/packages/express/express-plugin.md` → `# @nx/express`
- `docs/shared/packages/node/node-plugin.md` → `# @nx/node`
- `docs/shared/packages/nest/nest-plugin.md` → `# @nx/nest`
- `docs/shared/packages/expo/expo-plugin.md` → `# @nx/expo`
- `docs/shared/packages/react/react-plugin.md` → `# @nx/react`
- `docs/shared/packages/next/plugin-overview.md` → `# @nx/next`
- `docs/shared/packages/react-native/react-native-plugin.md` → `#
@nx/react-native`
- `docs/shared/packages/remix/remix-plugin.md` → `# @nx/remix`
- `docs/shared/packages/cypress/cypress-plugin.md` → `# @nx/cypress`
- `docs/shared/packages/detox/detox-plugin.md` → `# @nx/detox`
- `docs/shared/packages/jest/jest-plugin.md` → `# @nx/jest`
- `docs/shared/packages/playwright/playwright-plugin.md` → `#
@nx/playwright`
- `docs/shared/packages/storybook/plugin-overview.md` → `#
@nx/storybook`
- `docs/shared/packages/js/js-plugin.md` → `# @nx/js`
- `docs/shared/packages/vue/vue-plugin.md` → `# @nx/vue`
- `docs/shared/packages/nuxt/nuxt-plugin.md` → `# @nx/nuxt`

Note: The Angular Rspack introduction page
(`docs/shared/guides/angular-rspack/introduction.md`) already had an
appropriate H1
title "# Introduction" and was left unchanged.

All changes improve documentation consistency and navigation by ensuring
proper titles and direct links to overview pages.
 2025-06-18 09:50:44 -04:00
Jack Hsu
28b48ad1f3
docs(misc): update URls that should point to intro pages rather than API index pages (#31531) 
This PR fixes an issue introduced when we removed `/nx-api` pages:
https://github.com/nrwl/nx/pull/31453.

Most of the old `/nx-api/<plugin>` URLs should now go to
`/technologies/<plugin>/introduction`, since those pages contain what
was on the previous "overview" pages.

The only exception are places where we explicitly link to
`.../api/{generators,executors,migrations}` URLs, and the following
three blog posts that we want users to land on the API index.

-
https://github.com/nrwl/nx/blob/master/docs/blog/2022-03-29-the-react-cli-you-always-wanted-but-didnt-know-about.md?plain=1#L132
(https://nx.dev/blog/the-react-cli-you-always-wanted-but-didnt-know-about)
-
https://github.com/nrwl/nx/blob/master/docs/blog/2022-04-08-what-is-new-in-nx-13-10.md?plain=1#L245
(https://nx.dev/blog/what-is-new-in-nx-13-10)
-
https://github.com/nrwl/nx/blob/master/docs/blog/2022-05-02-nx-v14-is-out-here-is-all-you-need-to-know.md?plain=1#L253
(https://nx.dev/blog/nx-v14-is-out-here-is-all-you-need-to-know)
 2025-06-10 15:08:29 -04:00
Colum Ferry
e73a1411a0
feat(storybook)!: support storybook 9 (#31172) 
## Current Behavior
We currently do not have support for Storybook 9, nor any migrations to
help users switch to it.


## Expected Behavior
Support Storybook 9 and add a migration for users to switch to v9

BREAKING CHANGE: Remove deprecated generators:
`@nx/storybook:cypress-project`,
`@nx/react-native:storybook-configuration`, `@nx/react-native:stories`,
`@nx/react-native:component-story`
 2025-06-06 12:51:47 -04:00
Jack Hsu
66eaf2fc74
docs(misc): remove /nx-api pages (#31453) 
This PR removes the `/nx-api` pages from `nx-dev`. They are already
redirected from `/nx-api` to either `/technologies` or
`/reference/core-api` URLs.

e.g. `/nx-api/nx` goes to `/reference/core-api/nx` and `/nx-api/react`
goes to `/technologies/react/api`

**Changes**:
- Remove old `nx-api.json` from being generated in
`scripts/documentation/generators/generate-manifests.ts` -- this was
used to generate the sitemap
- Remove `pages/nx-api` from Next.js app since we don't need them
- Remove workaround from link checker
`scripts/documentation/internal-link-checker.ts` -- the angular
rspack/rsbuild and other workarounds are gone now that they are proper
docs in `map.json`
- Update Powerpack/Remote Cache reference docs to exclude API documents
(since they are duplicated in the Intro page) --
`nx-dev/models-document/src/lib/mappings.ts`
- All content in `docs` have been updated with new URL structure

**Note:** Redirects are already handled, and Claude Code was used to
verify the updated `docs/` URLs (see report below). The twelve 404s
links were updated by hand.

## Verification Report

https://gist.github.com/jaysoo/c7863fe7e091cb77929d1976165c357a
 2025-06-04 16:57:01 -04:00
Caleb Ukle
4f57f01d01
docs(core): move plugin api docs to tech plugin guides (#31402) 
# before

plugin api docs where stuck in `api` section which doesn't make sense

# after

move plugin api docs into `guides` section and add redirect for better
discoverability
 2025-06-03 13:43:24 -04:00
Juri Strumpflohner
b51676a89a
docs(core): restructure guides into technologies sections (#31288) 
Updates the docs structure, navigation etc to be easier + better suited
for showing Nx technology support beyond just TS.

**Notes:**

- API (`/nx-api`) tab is removed from the navigation (i.e. menu bar),
but pages still remain for now until we update references in `*.md`
files.
- Redirects are set up `/nx-api` to go to their respect new location
e.g. `/technologies` or `/reference/core-api`
- Old URLs still exist in the sitemap for now, but majority of them will
be redirected -- a follow-up PR can remove them.

**Preview:**
https://nx-dev-git-nx-dev-polyglot-docs-restructure-nrwl.vercel.app/docs

---------

Co-authored-by: Jack Hsu <jack.hsu@gmail.com>
 2025-05-29 14:55:34 -04:00
Jack Hsu
766d1b32e0
docs(misc): remove installation instructions for Nx < 18 (#30950) 
This PR removes installation instructions for Nx < 18 since it has
fallen out of support window. Users can always `npm install <plugin>` as
usual if they are on an unsupported Nx version, but the docs will assume
`nx add` moving forward.

The changes are on the plugin overview page:
https://nx-dev-git-docs-remove-nx-pre-18-install-nrwl.vercel.app/nx-api
 2025-04-30 14:34:28 -04:00
Isaac Mann
aedea54624
chore(nx-dev): check for broken anchor links (#23580) 
Checks for broken anchor links, except for links that go to `/nx-api` or
`/blog`
Fixes existing broken anchor links
 2024-05-21 09:31:37 -04:00
Isaac Mann
186a420a74
docs(core): decisions section (#23038) 
Create an "Organizational Decisions" section under Concepts for
recommendations and discussions about how to set up Nx that aren't firm
requirements.
 2024-05-10 15:42:46 -04:00
Jack Hsu
839e4b25fc
docs(core): remove deprecated docs page for Nx 14 and earlier (#22767) 2024-04-15 09:09:49 -04:00
Leosvel Pérez Espinosa
6576325f7b
docs(misc): fix misc issues (#22039) 
Co-authored-by: Isaac Mann <isaacplmann@users.noreply.github.com>
 2024-02-28 10:02:27 -05:00
Miroslav Jonaš
3ead01987b
fix(nx-dev): remove fence from new packages and "nx add" commands (#21705) 2024-02-08 14:43:50 +01:00
Isaac Mann
61436a64ef
docs(core): inferred targets (#21167) 
Co-authored-by: Katerina Skroumpelou <mandarini@users.noreply.github.com>
Co-authored-by: Colum Ferry <cferry09@gmail.com>
Co-authored-by: Emily Xiong <xiongemi@gmail.com>
Co-authored-by: Nicholas Cunningham <ndcunningham@gmail.com>
Co-authored-by: Jason Jean <jasonjean1993@gmail.com>
Co-authored-by: Victor Savkin <mail@vsavkin.com>
Co-authored-by: Jack Hsu <jack.hsu@gmail.com>
 2024-02-03 00:14:05 -05:00
Aditya Mathur
dd5f3c8d17
docs(misc): standardize all the install commands with different pm (#21226) 2024-01-19 15:21:42 +01:00
Katerina Skroumpelou
406018ca2d
docs(vue): all of vue docs (#19600) 2023-10-20 19:28:47 +03:00
Katerina Skroumpelou
5ec8b653a0
docs(storybook): remove entirely vue and nuxt pages (#19593) 2023-10-13 13:05:20 +03:00
Katerina Skroumpelou
cbeed02ee5
feat(nuxt): storybook generators (#19529) 2023-10-12 08:31:34 -06:00
Katerina Skroumpelou
1c08c8b2f9
fix(storybook): cleanup v17 tasks (#19560) 2023-10-11 18:54:29 +03:00
Katerina Skroumpelou
295ea3fb93
feat(vue): storybook configuration generator for vue (#19141) 2023-09-25 13:23:01 -04:00
Isaac Mann
d1fe398ea0
docs(core): packages to api (#19281) 2023-09-22 14:24:35 -04:00
Isaac Mann
4f3988cb2c
docs(core): sync nx package versions (#18973) 2023-09-08 08:25:19 -04:00
Zachary DeRose
e6eafaca46
docs(misc): community slack to official discord (#18873) 2023-09-07 11:01:39 -04:00
Katerina Skroumpelou
7f519d151a
docs(storybook): rearrange recipes and docs (#18732) 2023-08-21 09:44:29 -06:00
Ben McCann
fd6bccddff
docs(storybook): use ESM for Storybook configs (#18380) 2023-08-01 10:46:28 +00:00
Juri
dcecb6f46a docs(core): cleanup youtube tags 2023-07-31 11:19:07 +02:00
Katerina Skroumpelou
e06b9e0954 docs(storybook): interaction tests updated documentation 2023-07-28 15:59:58 +02:00
Miroslav Jonaš
331707d6eb
docs(nx-dev): make more concepts submenu (#18266) 2023-07-24 14:20:48 +00:00
Rivaldi Putra
71974ca135
docs(core): add pnpm command for storybook plugin (#17768) 2023-06-26 21:32:30 +03:00
Katerina Skroumpelou
a081233b85
docs(storybook): link storybook autodocs guide (#16860) 2023-05-08 18:31:53 +03:00
Isaac Mann
258b6df8b6
docs(core): plugin section (#16314) 2023-05-05 12:37:06 -04:00
Katerina Skroumpelou
32c176c359
docs(storybook): rearrange docs and more some to deprecated (#16805) 2023-05-05 10:53:46 -04:00
Katerina Skroumpelou
17e6db5568
feat(storybook): deprecate v6 support (#16650) 2023-05-04 18:02:18 +03:00
Isaac Mann
afa5eb59fa
docs(core): document the @nrwl => @nx rescope (#16403) 
Co-authored-by: FrozenPandaz <jasonjean1993@gmail.com>
 2023-04-27 18:14:59 -04:00
Katerina Skroumpelou
d5441020af
docs(storybook): overview adjusted for v7 (#16434) 2023-04-20 14:37:02 +01:00
Katerina Skroumpelou
a7bc1c6635
feat(storybook): added sb7 generator to migrations (#16369) 2023-04-18 17:24:26 +03:00
Jason Jean
95f2f80cd3
feat(core): remove @nrwl/workspace:run-commands and @nrwl/workspace:r… (#16298) 2023-04-14 18:06:47 -04:00
Victor Savkin
2bc33f14d7
docs(core): use -t and -p instead of --targets and --projects 2023-04-10 13:30:17 -04:00
Katerina Skroumpelou
c91c365fa2
fix(storybook): v7 gen docs and install react deps (#16057) 2023-04-03 13:50:53 +00:00
Katerina Skroumpelou
5e88d1d7d1
docs(storybook): improve docs around migration and react/angular (#15706) 2023-03-16 17:07:40 +02:00
Katerina Skroumpelou
5e0cb7cf59
docs(storybook): include note for older name of flag (#15662) 2023-03-14 19:11:26 +00:00
Katerina Skroumpelou
2e3e32cf30
feat(storybook): update to v7.0.0-rc (#15584) 2023-03-10 09:56:32 -05:00
Katerina Skroumpelou
399b8a46ec
docs(storybook): csf3 stories update (#15423) 2023-03-03 10:08:57 -05:00
Katerina Skroumpelou
df4efc281f
feat(storybook): version 7 automigrate integration (#15136) 2023-03-01 13:41:51 -05:00
Katerina Skroumpelou
b934edc3dc
chore(storybook): remove old change-storybook-targets generator (#15126) 2023-02-20 16:43:54 +00:00
Katerina Skroumpelou
929bece2fb
docs(storybook): reorder guides and refine config guide (#15128) 2023-02-20 16:43:37 +00:00
Katerina Skroumpelou
1b64e17d4e
fix(storybook): v7 vite settings docs remove rootMain (#14992) 2023-02-15 13:10:28 +02:00
Katerina Skroumpelou
61cadc301c
feat(storybook): remove root config files (#14780) 2023-02-07 14:30:34 -05:00
Katerina Skroumpelou
b7fe0a2311
docs(storybook): add titles and descriptions to all docs (#14749) 2023-02-01 17:03:51 +00:00
Katerina Skroumpelou
a10dc40f18
docs(misc): webpack overview page and other fixes (#14715) 2023-01-31 08:18:21 -05:00
Benjamin Cabanes
0e2eb29153
docs(nx-dev): fix documentation link error (#14713) 2023-01-30 19:41:11 -05:00