docs: rewrite documentation to be leaner and user-focused#83
Closed
michaelbe812 wants to merge 1 commit intomainfrom
Closed
docs: rewrite documentation to be leaner and user-focused#83michaelbe812 wants to merge 1 commit intomainfrom
michaelbe812 wants to merge 1 commit intomainfrom
Conversation
Consolidate 14 doc pages into 8. Reduce overall doc content from ~4600 lines to ~340 lines. Make it immediately obvious that @nx-plugin-openapi/core with a generator plugin (plugin-openapi or plugin-hey-api) is the recommended approach. Legacy package clearly marked with migration guide. - Merge getting-started (overview + installation + quick-start) into single page - Remove plugins/overview, usage/configuration, usage/examples, usage/nx-integration - Remove exhaustive reference/generate-api (replaced by lean configuration reference) - Trim plugin pages to essentials - Trim creating-plugins guide - Update landing page tagline and cards to be generator-agnostic - Update sidebar to match new structure - Rewrite all package READMEs Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
@nx-plugin-openapi/core+ a generator plugin (plugin-openapi or plugin-hey-api) is the recommended approachChanges
Test plan
nx build docs)🤖 Generated with Claude Code