Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve documentation #18

Merged
merged 20 commits into from
Dec 3, 2024
Merged

Conversation

lanjoni
Copy link
Member

@lanjoni lanjoni commented Nov 24, 2024

This PR aims to improve documentation around parenthesin/components by adding an introduction of usage and more detailed documentation around each component.

This is a WIP 🚧

@rafaeldelboni
Copy link
Member

Please, add a link to this new document in the main readme :)

@lanjoni lanjoni marked this pull request as ready for review December 1, 2024 23:51
@lanjoni lanjoni requested a review from rafaeldelboni December 1, 2024 23:52
@lanjoni lanjoni added the documentation Improvements or additions to documentation label Dec 1, 2024
doc/components.md Outdated Show resolved Hide resolved
doc/helpers.md Outdated Show resolved Hide resolved
@rafaeldelboni rafaeldelboni merged commit 84f54c1 into main Dec 3, 2024
6 checks passed
@rafaeldelboni rafaeldelboni deleted the doc/add-new-intro-documentation branch December 3, 2024 09:05
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.

2 participants