serenity
serenity copied to clipboard
Base: Give all applications a decent manpage + a link in the Help menu
A fair number of applications, demos and games are missing a manpage, have just a stub, poor grammar or are missing a link to the manual in the Help menu.
Applications should have:
- An initial or updated manpage
- A link to this in the
Helpmenu, if present
Settings applications for a specific application will be included in the main application's manpage (e.g. TerminalSettings is included in Terminal).
Applications:
- [x] 2048
- [x] 3DFileViewer
- [x] About
- [x] AnalogClock
- [x] Assistant
- [x] BrickGame
- [ ] Browser & BrowserSettings
- [ ] New/updated/OK manpage
- [x] Link in Help menu
- [x] Calculator
- [ ] Calendar & CalendarSettings
- [ ] New/updated/OK manpage
- [x] Link in Help menu
- [x] CatDog
- [x] CharacterMap
- [ ] Chess
- [ ] New/updated/OK manpage #22180
- [x] Link in Help menu
- [x] ColorLines
- [x] CrashReporter
- [ ] Eyes
- [ ] New/updated/OK manpage
- [x] Link in Help menu
- [ ] FileManager
- [x] FlappyBug
- [x] Flood
- [ ] FontEditor
- [ ] New/updated/OK manpage
- [x] Link in Help menu
- [ ] GameOfLife
- [ ] New/updated/OK manpage #22180
- [x] Link in Help menu
- [x] GMLPlayground
- [ ] HackStudio
- [x] Hearts
- [x] Help
- [x] HexEditor
- [x] ImageViewer
- [ ] KeyboardMapper
- [ ] LibGfxDemo & LibGfxScaleDemo
- [x] Magnifier
- [ ] Mail & MailSettings
- [ ] Mandelbrot
- [x] Maps & MapsSettings
- [x] MasterWord
- [x] Minesweeper
- [ ] ModelGallery
- [ ] PartitionEditor
- [ ] PDFViewer
- [ ] Piano
- [x] PixelPaint
- [x] Presenter
- [x] Profiler
- [ ] Run
- [ ] Screensaver
- Gradient
- Starfield
- Tubes
- [x] Screenshot
- [ ] Settings
- CertificateSettings
- ClockSettings
- DisplaySettings
- GamesSettings
- KeyboardSettings
- MouseSettings
- NetworkSettings
- [x] Snake
- [x] Solitaire
- [ ] SoundPlayer
- [ ] SpaceAnalyzer
- [x] Spider
- [ ] Spreadsheet
- [x] SQLStudio
- [ ] SystemMonitor
- [x] Terminal & TerminalSettings
- [x] TextEditor
- [ ] ThemeEditor
- [ ] VideoPlayer #24034
- [ ] WidgetGallery
I will gradually be working through these, but please help if you can!
If you're willing to add a link to an application’s help menu but it has no existing manpage and you don’t fancy writing one - create a stub page with a one-line description, and I'll handle the full-page write-up.
Seems this list has quite a lot of overlap with https://github.com/SerenityOS/serenity/issues/11311
@ADKaster You're right. This is slightly different in that it includes expanding and improving manpages (some have been stubs or had pretty poor grammar) and making sure they are linked in the application's Help Menu.
Would a better solution be to ask Sam for permission to edit the existing issue as I'll make sure to keep it up to date?
Unfortunately I can't give you permission to edit that issue. GitHub either lets you just edit your own, or EVERYTHING.
I've no idea how up to date the other issue is, so maybe it'd be best to make that just about Utilities now, and you can keep an eye on Applications, since you already seem to have a good idea of what the situation is. :^)
Thanks for taking these on by the way!
For the following applications, adding a manual link to the help-context menu, doesn't really make sense since they either don't use normal windows, or are meant to only temporarily show when used. For those marked with * a help button somewhere would still make sense but adding it as a Context Menu wouldn't make much sense
- Assistant *
- CatDog
- Run *
So I have done a bit of Work for this in #21731
Thanks for your help @Popaulol!
PSA: I haven’t forgotten about this issue, I am working on the Pixel Paint manpage which is going to take some time to get right.