mono/Embeddinator-4000

[general] Improve docs, showcase and contributing section

Open

#160 opened on Apr 22, 2017

View on GitHub
 (2 comments) (0 reactions) (1 assignee)C# (91 forks)github user discovery
enhancementhelp wanted

Repository metrics

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

Description

Currently the github page of Embeddinator is lacking detailed information about how it works, where it's useful, how to contribute etc. I consider this as very important.

My suggestions is following: Start with adding a wiki which describes in more detail how to use it, add some examples both to the repository and the wiki and at least at a contributing.md .

Contributor guide

Research direction
Review the existing documentation, then create a wiki page with usage examples and a CONTRIBUTING.md file. Follow the project's existing style and link to relevant resources.
Tech stack
csharp
Domain
documentationdevtools
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75