Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Base: Give all applications a decent manpage + a link in the Help menu #21091

Open
37 of 69 tasks
cubiclove opened this issue Sep 15, 2023 · 6 comments
Open
37 of 69 tasks
Labels
good first issue Good for newcomers task list This issue contains a list of tasks.

Comments

@cubiclove
Copy link
Contributor

cubiclove commented Sep 15, 2023

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.

Manual Option

Applications should have:

  • An initial or updated manpage
  • A link to this in the Help menu, 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:

  • 2048
  • 3DFileViewer
  • About
  • AnalogClock
  • Assistant
  • BrickGame
  • Browser & BrowserSettings
    • New/updated/OK manpage
    • Link in Help menu
  • Calculator
  • Calendar & CalendarSettings
    • New/updated/OK manpage
    • Link in Help menu
  • CatDog
  • CharacterMap
  • Chess
  • ColorLines
  • Eyes
    • New/updated/OK manpage
    • Link in Help menu
  • FileManager
  • FlappyBug
  • Flood
  • FontEditor
    • New/updated/OK manpage
    • Link in Help menu
  • GameOfLife
  • GMLPlayground
  • HackStudio
  • Hearts
  • Help
  • HexEditor
  • ImageViewer
  • KeyboardMapper
  • LibGfxDemo & LibGfxScaleDemo
  • Magnifier
  • Mail & MailSettings
  • Mandelbrot
  • Maps & MapsSettings
  • MasterWord
  • Minesweeper
  • ModelGallery
  • PartitionEditor
  • PDFViewer
  • Piano
  • PixelPaint
  • Presenter
  • Profiler
  • Run
  • Screensaver
    • Gradient
    • Starfield
    • Tubes
  • Screenshot
  • Settings
    • CertificateSettings
    • ClockSettings
    • DisplaySettings
    • GamesSettings
    • KeyboardSettings
    • MouseSettings
    • NetworkSettings
  • Snake
  • Solitaire
  • SoundPlayer
  • SpaceAnalyzer
  • Spider
  • Spreadsheet
  • SQLStudio
  • SystemMonitor
  • Terminal & TerminalSettings
  • TextEditor
  • ThemeEditor
  • VideoPlayer VideoPlayer: Manual Added #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.

@ADKaster
Copy link
Member

Seems this list has quite a lot of overlap with #11311

@cubiclove
Copy link
Contributor Author

cubiclove commented Sep 17, 2023

@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?

@AtkinsSJ
Copy link
Member

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!

@AtkinsSJ AtkinsSJ added the task list This issue contains a list of tasks. label Sep 18, 2023
@cubiclove cubiclove changed the title Userland: Give all applications a decent manpage + a link in the Help menu Base: Give all applications a decent manpage + a link in the Help menu Sep 18, 2023
@timschumi timschumi added the good first issue Good for newcomers label Oct 3, 2023
@Popaulol
Copy link
Contributor

Popaulol commented Nov 1, 2023

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 *

@Popaulol
Copy link
Contributor

Popaulol commented Nov 2, 2023

So I have done a bit of Work for this in #21731

@cubiclove
Copy link
Contributor Author

cubiclove commented Nov 8, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers task list This issue contains a list of tasks.
Projects
None yet
Development

No branches or pull requests

5 participants