Skip to content

Commit 4d2c8e7

Browse files
michaelbe812claude
andcommitted
docs: move legacy plugin to own section and update landing page
- Move @lambda-solutions/nx-plugin-openapi docs to dedicated "Legacy Nx Plugin" top-level section - Update landing page to highlight plugin system: - Replace "Flexible Configuration" with "Extensible Plugin System" - Add plugin architecture to features list - Update plugins overview to reference new legacy section location - Remove legacy plugin from plugins section (now standalone) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent deecf21 commit 4d2c8e7

4 files changed

Lines changed: 14 additions & 18 deletions

File tree

apps/docs/astro.config.mjs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ export default defineConfig({
3232
{ label: 'Overview', slug: 'plugins/overview' },
3333
{ label: 'OpenAPI Generator', slug: 'plugins/plugin-openapi' },
3434
{ label: 'hey-api', slug: 'plugins/plugin-hey-api' },
35-
{ label: '@lambda-solutions/nx-plugin-openapi', slug: 'plugins/legacy-plugin' },
3635
],
3736
},
3837
{
@@ -55,6 +54,12 @@ export default defineConfig({
5554
{ label: 'Creating Custom Plugins', slug: 'guides/creating-plugins' },
5655
],
5756
},
57+
{
58+
label: 'Legacy Nx Plugin',
59+
items: [
60+
{ label: 'Overview', slug: 'legacy-nx-plugin/overview' },
61+
],
62+
},
5863
{
5964
label: 'Roadmap',
6065
items: [{ label: 'Roadmap', slug: 'roadmap/roadmap' }],

apps/docs/src/content/docs/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
3434
<Card title="⚡ Powerful Caching" icon="lightning">
3535
Leverages Nx's intelligent caching to avoid regenerating unchanged API clients.
3636
</Card>
37-
<Card title="🔧 Flexible Configuration" icon="setting">
38-
Supports all OpenAPI Generator options with TypeScript-safe configuration.
37+
<Card title="🔧 Extensible Plugin System" icon="setting">
38+
Choose from multiple code generators or create your own custom plugins.
3939
</Card>
4040
<Card title="📦 TypeScript-Angular Ready" icon="puzzle">
4141
Generates Angular-compatible TypeScript clients out of the box using the well established <a href="https://openapi-generator.tech/docs/generators/typescript-angular">OpenAPI Generator for Angular.</a>
@@ -45,8 +45,8 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
4545
## Features
4646

4747
- **🎯 Executor-based**: Use `nx run my-app:generate-api` to generate API clients
48+
- **🔌 Plugin Architecture**: Choose between [OpenAPI Generator](/plugins/plugin-openapi/) or [hey-api](/plugins/plugin-hey-api/), or [create your own](/guides/creating-plugins/)
4849
- **📁 File & URL Support**: Work with local OpenAPI specs or remote URLs
49-
- **⚙️ Extensive Configuration**: Support for 30+ OpenAPI Generator options
5050
- **🔄 Smart Caching**: Only regenerates when OpenAPI specs change
5151

5252
## Quick Example
File renamed without changes.

apps/docs/src/content/docs/plugins/overview.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@ The Nx Plugin OpenAPI ecosystem provides a modular plugin architecture, allowing
1313
|--------|---------|-----------------|-------------|
1414
| [OpenAPI Generator](/plugins/plugin-openapi/) | `@nx-plugin-openapi/plugin-openapi` | `openapi-tools` | Uses the battle-tested [OpenAPI Generator](https://openapi-generator.tech) |
1515
| [hey-api](/plugins/plugin-hey-api/) | `@nx-plugin-openapi/plugin-hey-api` | `hey-api` | Uses [hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) for modern TypeScript clients |
16-
| [Legacy Plugin](/plugins/legacy-plugin/) | `@lambda-solutions/nx-plugin-openapi` | N/A (standalone) | Original standalone plugin for OpenAPI Generator |
16+
17+
:::note[Legacy Package]
18+
Looking for the original `@lambda-solutions/nx-plugin-openapi` package? See the [Legacy Nx Plugin](/legacy-nx-plugin/overview/) section.
19+
:::
1720

1821
## Architecture
1922

@@ -66,18 +69,6 @@ The plugin system is built around a core package that provides:
6669
- Plugin-based architecture for customization
6770
- Modern ESM output
6871

69-
### Legacy Plugin (`@lambda-solutions/nx-plugin-openapi`)
70-
71-
**Best for:**
72-
- Existing projects already using this plugin
73-
- Teams who want a single-package solution
74-
- Angular projects with simpler requirements
75-
76-
**Features:**
77-
- All-in-one package (no separate core/plugin)
78-
- Dedicated executor for OpenAPI Generator
79-
- Same Nx integration features
80-
8172
## Using Multiple Generators
8273

8374
You can use different generators for different projects in your monorepo:
@@ -120,4 +111,4 @@ Need to integrate a different OpenAPI generator? The plugin architecture makes i
120111

121112
- [OpenAPI Generator Plugin](/plugins/plugin-openapi/) - Full documentation for the OpenAPI Generator plugin
122113
- [hey-api Plugin](/plugins/plugin-hey-api/) - Full documentation for the hey-api plugin
123-
- [Legacy Plugin](/plugins/legacy-plugin/) - Documentation for the original standalone plugin
114+
- [Creating Custom Plugins](/guides/creating-plugins/) - Build your own generator plugin

0 commit comments

Comments
 (0)