MithrilJS / mithril.js

A JavaScript Framework for Building Brilliant Applications
https://mithril.js.org
MIT License
13.99k stars 926 forks source link

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

Open dead-claudia opened 6 years ago

dead-claudia commented 6 years ago

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.

orbitbot commented 6 years ago

I won't voice my reservations here, but ask if anyone takes on the above, then please replicate the appropriate sections here as well https://github.com/orbitbot/awesome-mithril . Also, perhaps this could be reflected in a GH Project for better assignment & overview?

dead-claudia commented 6 years ago

@orbitbot

I won't voice my reservations here

Feel free to detail them. My "have any questions" should really read as "have any questions or comments" (I updated it to clarify this). My only request is that we keep the signal/noise ratio at an okay level.

if anyone takes on the above, then please replicate the appropriate sections here as well

I've added a subsection to see about reducing duplication, since about a third of the listed projects could very well go in that list.

Also, perhaps this could be reflected in a GH Project for better assignment & overview?

That's something I'd like to bring up with the other maintainers first, since projects are currently disabled.

orbitbot commented 6 years ago

Sorry, didn't mean to leave this all hanging, but I have been really busy with RL stuff over the last few weeks.

The main issue I have with the wiki is that it suffers from a discovery problem for readers, on the same level or even worse than the main mithril.js.org website, in that you have to read through all of it to know where anything is. IME, wikis work a lot better as a intra-org workspace for writing down thoughts and WIP documentation rather than something that everyone is supposed to be browsing. Along with not having update notifications and arbitrary nesting of pages it's just a dungeon unless someone spends time maintaining it or comes up with a structure to enforce.

Wrt. to discovery issues, the first problem is that the wiki itself is not mentioned either on the main GH readme or the mithril.js.org website (if memory serves). I feel that most of the content in the wiki is 0.2-oriented and probably abandoned by now, at least that's the impression I get from looking through some of it. Which obviously can be fixed with a bit of work, but I'm wondering if it's worth it or not, and would say that most of the categories listed above would be better or equally served by either 1) moving the content to the main mithril.js.org website or 2) posted in the awesome-mithril repo as links in the yellow-pages format that has become popular in the last few years. Having one of those helps with discovery, I'd argue.

dead-claudia commented 6 years ago

I'd be good with that, since 90% of the content makes the most sense in either the docs itself or your awesome-mithril list. Probably, the only subsection that would require further consideration is where to move/redirect the jobs section (Edit: assuming we move it at all).