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 a documentation site #21

Open
mmontes11 opened this issue Dec 20, 2022 · 1 comment
Open

Create a documentation site #21

mmontes11 opened this issue Dec 20, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation feature priority-mid-term To be resolved in the mid term

Comments

@mmontes11
Copy link
Member

mmontes11 commented Dec 20, 2022 •
edited

The README.md is a bit lacking and the examples aren't enough, we should create a documentation site using this:

Some sources of inspiration:

Topics to be documented:
@mmontes11 mmontes11 added the docs label Dec 20, 2022
@mmontes11 mmontes11 mentioned this issue Dec 20, 2022
Closed
@mmontes-f3 mmontes-f3 mentioned this issue Jan 19, 2023
Closed
@mmontes11 mmontes11 mentioned this issue Feb 21, 2023
Closed
@mmontes11 mmontes11 added the priority-short-term To be resolved in the short term label Mar 19, 2023
@mmontes11 mmontes11 added priority-mid-term To be resolved in the mid term and removed priority-short-term To be resolved in the short term labels May 7, 2023
@mmontes11 mmontes11 mentioned this issue Jun 2, 2023
Closed
@mmontes11 mmontes11 added documentation Improvements or additions to documentation and removed docs labels Apr 10, 2024
@mariadb-pieterhumphrey
Copy link
Collaborator

considering gh pages

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation feature priority-mid-term To be resolved in the mid term
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mmontes11 @mariadb-pieterhumphrey