jquery / jquery/contribute.jquery.org

Create Prose Style Guide

Open
#75 17 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
28
Forks
73
PR merge metrics
No merged PRs in 30d

Description

Most of http://learn.jquery.com/style-guide/ should be moved here as the prose style guide spans everything from READMEs to API documentation to articles and tutorials.

The index page will need to be updated as well, as that links to the various existing guides.

Contributor guide

Open the contributing guide

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 by reviewing the existing prose style guide at http://learn.jquery.com/style-guide/ and the contribution site’s index page. Identify where the existing guides are linked and move the prose guidance covering READMEs, API documentation, articles, and tutorials; done means the content is present here and the index links are updated.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.