[Spec-Insert] Added Readme file for Spec-Insert #9638
Conversation
Signed-off-by: Theo Truong <[email protected]>
nhtruong
requested review from
kolchfa-aws,
Naarcha-AWS,
AMoo-Miki,
natebower,
dlvenable and
epugh
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
There was a problem hiding this comment.
@Naarcha-AWS Please see my comments and changes and tag me for approval when addressed. Thanks!
spec-insert/README.md
Outdated
|
|
||
| - API parser: Parses the OpenAPI spec and extracts the relevant component information | ||
| - Component renderer: Renders the extracted component information into Markdown format | ||
| - Reporters: Generates reports for this plugin |
There was a problem hiding this comment.
Should "Reporters" be "Reports" or "Reporter"?
spec-insert/README.md
Outdated
|
|
||
| Each of these components is rendered within a [`SpecInsert`](./lib/renderers/spec_insert.rb) class, which wraps the rendered component within `<!-- spec_insert_start -->` and `<!-- spec_insert_end -->` comments. | ||
|
|
||
| ## Reporters |
There was a problem hiding this comment.
Should "Reporters" be "Reports" or "Reporter"?
spec-insert/README.md
Outdated
|
|
||
| Each of these components is rendered within a [`SpecInsert`](./lib/renderers/spec_insert.rb) class, which wraps the rendered component within `<!-- spec_insert_start -->` and `<!-- spec_insert_end -->` comments. | ||
|
|
||
| ## Reporters |
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.