Ygg01/Linguini

Improve docs

Open

#23 opened on May 30, 2022

View on GitHub
 (1 comment) (1 reaction) (0 assignees)C# (15 forks)auto 404
documentationgood first issuehelp wanted

Repository metrics

Stars
 (42 stars)
PR merge metrics
 (PR metrics pending)

Description

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.

Contributor guide

Research direction
Review existing documentation in the repository, identify gaps such as missing API docs or examples, and propose additions following the project's style.
Tech stack
csharp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitC#
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90