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.

Sign up for GitHub

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

Jump to bottom

Create documentation for the packages API features #34

Open
helderberto opened this issue Nov 25, 2021 · 0 comments
Open

Create documentation for the packages API features #34

helderberto opened this issue Nov 25, 2021 · 0 comments
Labels
status: available No one has claimed responsibility for resolving this issue type: documentation Changes to documentation only type: question Further information is requested
Milestone
💎 Blackout 2.0

Comments

@helderberto
Copy link
Contributor

Describe the solution you'd like

It would be nice we dedicate some time to create documentation that represents the usage of the packages and their API features.

It will help our package users to consult based on the docs method of implementing the solutions.

Describe alternatives you've considered

Tools commonly used by the libraries to create nice docs:

And others.
@helderberto helderberto added type: documentation Changes to documentation only status: on hold Similar to blocked, but is assigned to someone (although unable to process the issue at this time) labels Nov 25, 2021
@nelsonleite nelsonleite added type: question Further information is requested and removed status: on hold Similar to blocked, but is assigned to someone (although unable to process the issue at this time) labels Nov 25, 2021
@nelsonleite nelsonleite added the status: available No one has claimed responsibility for resolving this issue label Dec 7, 2021
@nelsonleite nelsonleite added this to the 💎 Blackout 2.0 milestone Jan 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
status: available No one has claimed responsibility for resolving this issue type: documentation Changes to documentation only type: question Further information is requested
Milestone
💎 Blackout 2.0
Development

No branches or pull requests
2 participants
@helderberto @nelsonleite