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

Improve docs #23

Open
Ygg01 opened this issue May 30, 2022 · 0 comments
Open

Improve docs #23

Ygg01 opened this issue May 30, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Milestone
1.0 Release

Comments

@Ygg01
Copy link
Owner

Ygg01 commented May 30, 2022 •
edited
Loading

This is more of a meta issue, so contributors can expand docs and add it.

What docs are needed?

  • API Docs. Easiest to add needed on most public methods
  • How-To. Just a quick cookbook examples how to setup some Linguini in a specific case. No external dependencies needed.
  • Tutorial??. Possibly needed, but Linguini is relatively simple.
  • Onboarding docs for new contributors?? Not sure what people need.
@Ygg01 Ygg01 added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels May 30, 2022
@Ygg01 Ygg01 added this to the 1.0 Release milestone Feb 23, 2023
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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
1.0 Release
Development

No branches or pull requests
1 participant
@Ygg01