docs: update documentation for new package structure (Fixes #75)#81
Merged
michaelbe812 merged 6 commits intomainfrom Jan 23, 2026
Merged
docs: update documentation for new package structure (Fixes #75)#81michaelbe812 merged 6 commits intomainfrom
michaelbe812 merged 6 commits intomainfrom
Conversation
- Add comprehensive package overview table - Add architecture diagram showing core and plugins - Add quick start examples for both generators - Add links to documentation site - Document available generators (openapi-tools, hey-api)
- Update docs site with new architecture explaining core + plugins - Update installation guide with @nx-plugin-openapi/core and plugin packages - Update quick-start with generator option and hey-api examples - Update configuration docs with generator and generatorOptions - Update generate-api reference with all core options and hey-api section - Update examples with hey-api specific examples - Update nx-integration to use new package references - Update core, plugin-openapi, and plugin-hey-api READMEs with comprehensive documentation
Add detailed documentation explaining how to create custom plugins to integrate arbitrary OpenAPI code generators with the nx-plugin-openapi plugin system. Includes: - Step-by-step implementation guide - Core concepts (interfaces, base class, context) - Real-world examples (openapi-typescript, swagger-typescript-api) - Best practices and troubleshooting tips - Code examples for both API and CLI integration patterns Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Contributor
Author
Replace with statement about plugin system |
Contributor
Author
|
Landingpage Add statement about plugin system |
michaelbe812
commented
Jan 22, 2026
Contributor
Author
michaelbe812
left a comment
michaelbe812
left a comment
There was a problem hiding this comment.
Code Review Summary
📊 Overall Assessment: Excellent Documentation Update
This PR comprehensively addresses issue #75 by updating all documentation to reflect the new modular package structure.
📊 Changes Reviewed
| Category | Files Changed | Additions | Deletions |
|---|---|---|---|
| Root README | 1 | 127 | 4 |
| Docs Site | 9 | 1,299 | 95 |
| Package READMEs | 3 | 351 | 18 |
| Total | 13 | 1,779 | 117 |
✨ Highlights
-
Excellent Architecture Documentation
- Clear ASCII diagrams showing core/plugin relationships
- Well-organized package overview tables
- Proper links to documentation site
-
Comprehensive Plugin Guide
- The new
apps/docs/src/content/docs/guides/creating-plugins.md(805 lines) is outstanding - Step-by-step implementation guide with real-world examples
- Covers both API and CLI integration patterns
- Includes best practices, troubleshooting, and error handling
- The new
-
Consistent Updates Across All Docs
- All executor references correctly updated from
@lambda-solutions/nx-plugin-openapito@nx-plugin-openapi/core - Generator option properly documented throughout
- Both
openapi-toolsandhey-apigenerators covered
- All executor references correctly updated from
-
Package READMEs
- Each package now has proper documentation with installation, usage, and options
- Consistent structure across all packages
✅ Verification
- Linting passes (
nx run-many --target=lint --all) - Tests pass (
nx run-many --target=test --all) - Documentation structure is consistent
- All internal links appear correct
- Code examples are syntactically correct
📝 Minor Observations (Non-blocking)
-
generate-api.md line 1540: File ends without a newline - very minor, but could be added for consistency
-
hey-api version: The peer dependency mentions
^0.83.1in plugin-hey-api README - ensure this matches what's inpackage.json
🎉 Conclusion
This PR represents significant effort to bring the documentation in line with the new package architecture. The new plugin creation guide is particularly valuable for the ecosystem. The documentation is well-written, thorough, and provides excellent guidance for both new users and those wanting to extend the plugin.
Great work! 👏
Automated review by Claude Code
- Add Plugins section to documentation sidebar - Create overview page explaining the plugin architecture - Add dedicated pages for each plugin: - OpenAPI Generator plugin (@nx-plugin-openapi/plugin-openapi) - hey-api plugin (@nx-plugin-openapi/plugin-hey-api) - Legacy plugin (@lambda-solutions/nx-plugin-openapi) - Include complete configuration reference for legacy plugin - Update README with links to new plugins documentation Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- 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>
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/coreas the central package and generator plugins (plugin-openapi,plugin-hey-api)@lambda-solutions/nx-plugin-openapito@nx-plugin-openapi/coreChanges
Root README.md
Documentation Site (apps/docs)
Getting Started
overview.md: Explained plugin architecture, added available generators table, added generator comparison sectioninstallation.md: Added installation instructions for core + plugins, documented auto-installation, added legacy package sectionquick-start.md: Updated to use@nx-plugin-openapi/core:generate-api, added examples for both generatorsUsage
configuration.md: Addedgeneratoroption documentation, addedgeneratorOptionssection, updated executor referencesexamples.md: Added hey-api specific examples, updated all executor referencesnx-integration.md: Updated all executor referencesReference
generate-api.md: Addedgeneratoroption, addedgeneratorOptionsdocumentation, added hey-api section with optionsPackage READMEs
packages/core/README.md: Comprehensive documentation for the core package including executors, generators, and plugin developmentpackages/plugin-openapi/README.md: Documentation for the OpenAPI Generator plugin with options and examplespackages/plugin-hey-api/README.md: Documentation for the hey-api plugin with options and examplesTest plan
nx run-many --target=lint --all)nx run-many --target=test --all)Fixes #75
🤖 Generated with Claude Code