serenity icon indicating copy to clipboard operation
serenity copied to clipboard

Published 20 hours ago • verified publisher icon SerenityOS

Documentation: List of (file) formats that need better documentation

Open kleinesfilmroellchen opened this issue 3 years ago • 2 comments

Came across this while working on #14293; in the same vein as #11311 here's a list of Serenity file formats we should document better.

  • [ ] IPC
  • [x] GML
  • [ ] .font
  • [ ] INI (Yes, that's here intentionally; 1-2 paragraphs will suffice)
  • [ ] PixelPaint's .pp
  • [ ] .af
  • [x] .postcreate

kleinesfilmroellchen avatar Jun 16 '22 15:06 kleinesfilmroellchen

I'll be working on this task.

Do we want to document them in ./Documentation/FileFormats.md or in man pages? Or we want to have them in both places?

overriden-sfdd avatar Jun 27 '22 22:06 overriden-sfdd

See #14293 , these belong into the manpages.

kleinesfilmroellchen avatar Jun 28 '22 13:06 kleinesfilmroellchen

Looks like https://github.com/SerenityOS/serenity/pull/14603 resolved this issue

JsFlo avatar Aug 07 '22 05:08 JsFlo