Skip to content

Expand README with usage, attributes and architecture overview#8

Merged
piotrooo merged 1 commit into
masterfrom
docs/expand-readme
Apr 29, 2026
Merged

Expand README with usage, attributes and architecture overview#8
piotrooo merged 1 commit into
masterfrom
docs/expand-readme

Conversation

@piotrooo

Copy link
Copy Markdown
Member

Summary

  • Rewrite README to clearly state what the library does (generate OpenAPI 3.0.1 from Ouzo RouteRules).
  • Add Requirements, Installation, three-step Usage (provider → customizer → generate), #[Hidden]/#[Schema] examples, polymorphism note, and a brief architecture sketch (PathsService/ComponentsService/OpenApiCustomizersRepository).
  • Replace absolute GitHub links with repo-relative ones.

Test plan

  • Render README on GitHub and verify all section anchors and code blocks display correctly.
  • Confirm relative links (src/OpenApi/RouteRulesProvider.php, src/OpenApi/Customizer/OpenApiCustomizer.php) resolve on the merged commit.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@piotrooo piotrooo self-assigned this Apr 29, 2026
@piotrooo piotrooo requested a review from bbankowski April 29, 2026 10:49
@piotrooo piotrooo added the documentation Improvements or additions to documentation label Apr 29, 2026
@piotrooo piotrooo merged commit 34129a0 into master Apr 29, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant