MithrilJS / MithrilJS/mithril.js

The wiki is full of things that are 0.2.x-specific, among other outdated things...

Open
#1,987 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area: Documentation Type: Bug
Dominant language
JavaScript
Stars
14.5k
Forks
922
PR merge metrics
No merged PRs in 30d

Description

If we could get some help cleaning that up, it'd be wonderful. All volunteers are welcome, regardless of experience. Here's a link to the wiki.

Some of the things that need done:

  1. Making sure 0.2.x stuff is marked as such.
  2. Making sure that everything is in fact up to date, including links.
  3. Making sure that the code is clean, readable, and updated to 1.x as applicable.
  4. Figuring out what actually belong in the wiki vs the docs, awesome-mithril, or elsewhere.

Here's a list of the wiki sections:

If you wish to get started on a section, tell me in this issue, and I'll put your name on this so people can tell who's on it (so you're not duplicating another's work). Once you finish one, please let me know, and I'll update this to check that box.

Also, if you need any help, or if you have any questions or comments, please tell me here, and I'll try to answer everything as best as I can.


If you want to keep tabs on progress and changes being made, you can always look here as well as this bug.

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

Choose a wiki section from the checklist and first read that page plus its history at the linked wiki URLs. Review 0.2.x labels, outdated links, code examples, and whether content belongs in the wiki, docs, or elsewhere. Done means the section is updated and the issue records who is working on it and when it is complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.