osu-wiki icon indicating copy to clipboard operation
osu-wiki copied to clipboard

Clean up `Client/File_formats/Osu(file_format)`

Open RetteraDev opened this issue 2 years ago • 3 comments

RetteraDev avatar Mar 22 '22 22:03 RetteraDev

please only resolve conversations after you've pushed the changes

Walavouchey avatar Mar 24 '22 18:03 Walavouchey

I've taken a look at the diff, both visual and textual, and can't fully wrap my head around it. perhaps it's the format specification itself that is lengthy and verbose, or it's the wiki in its current form that doesn't support all possible things in the world that would help digest the material, but I don't see any easy way to improve the page.

one suggestion is that in place of block quotes (which we do not use for formatting) you could use more tables, but that's pretty much all I can come up with. if I recall correctly, we have a similar issue with the skinning pages, where it's mostly a bunch of bullet point lists with different facts, things and gotchas about the stuff.

as for the fact checking, @RetteraDev do you think you could test what different reviewers have pointed out and fix the source article if possible? seems like a quick task, otherwise, if you want to scope your changes to formatting and formatting only, add a TODO which references a specific comment for every point you decide to omit.

tl;dr

  • [ ] block quotes -> tables to follow the rest of the article
  • [ ] either fix factual errors, or add specific TODOs which reference GitHub comments
  • [ ] fix style errors
  • [ ] give it another read, perhaps something will come to mind

TicClick avatar Apr 12 '22 02:04 TicClick

@RetteraDev 6 weeks later, are you going to return to the PR, or would rather ditch it (not that it's a bad thing, I totally get it)?

TicClick avatar May 25 '22 23:05 TicClick

closing as nothing seems to happen (and unlikely will) -- feel free to reopen if I am wrong

TicClick avatar Aug 18 '22 19:08 TicClick

I'll keep this one in my notifications and get back to it sometime, probably in the form of a new PR though. some new explanations, examples, and formatting here are worth adding but it's buried in a lot of (imo) unproductive reformatting

cl8n avatar Aug 19 '22 10:08 cl8n