jquery / jquery/learn.jquery.com

JQuery Core is organized in the wrong order

Open
#393 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted
Dominant language
JavaScript
Stars
915
Forks
471
PR merge metrics
No merged PRs in 30d

Description

Hi

I've been learning jquery through the "JQuery Core" pages. It's great,
but it teaches things in the wrong order.

Pages "selecting elements", and "working with selections"
should be the first pages.
Then, pages like "$ vs. $()" and $(document).ready() which are the first two pages (!), should appear much later - since the reader has no idea what those things mean yet... at least I didn't.

Basically - the first 4 pages should be moved to the end in the sequence.

Also, the first page should probably be a "getting started page" which
shows the basic abilities. Maybe a repeat of "How JQuery Works" page from the intro.

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 locating the JQuery Core page sequence and the intro’s “How JQuery Works” page. Review the current ordering of “$ vs. $()”, “$(document).ready()”, “selecting elements”, and “working with selections”. Done means the introductory sequence is reordered as requested and a suitable getting-started page is added or identified.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.