Marak / Marak/JSLINQ

Better documentation, more examples of code in the ReadMe file

Open
#4 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Community
Dominant language
JavaScript
Stars
92
Forks
12
PR merge metrics
No merged PRs in 30d

Description

a lot of people have been hitting the page and assuming that JSLINQ can only do the samples we've shown.

we need to have more examples with complex use cases. http://maraksquires.com/JSLINQ/ is a good start, but we need more examples and we need the example HTML and output rendered as MarkDown

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the README and review the examples at http://maraksquires.com/JSLINQ/. Add examples covering more complex JSLINQ use cases, then represent the example HTML and rendered output as Markdown. Done means the README gives readers more varied examples than the current samples.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.