Skip to content

Season of Docs projects

Waldir Pimenta edited this page Apr 7, 2019 · 42 revisions

The following are some ideas for potential projects to submit to the Season of Docs program. See also the list of projects for the coding programs like GSoC or CCI.

Move duplicate pages from linux/ and osx/ into common/

  • Summary: TBD Note: We will want to check not just for availability, but for compatible interfaces as well (e.g. GNU vs. BSD versions of the same tool).
  • Required skills:
  • Difficulty:
  • Potential mentors: @pxgamer?

Implement new syntax for pages

  • Summary: (WIP) see #958
  • Required skills: Markdown formatting; asynchronous coordination of multiple stakeholders (client authors, PR submitters, project maintainers, etc.)
  • Difficulty: challenging
  • Potential mentors: @waldyrious

Merge the lists of clients on the wiki, the README and the website

Completeness: create missing pages

  • Summary: tldr pages are not limited to the tools available in popular systems (either installed by default or available in the software repositories); that said, comparing completeness against well-known collections of CLI tools is a good way to ensure coverage of the needs of most users. This project involves reaching full parity with various popular sets of CLI tools, and is comprised of several sub-goals:
    • Create all missing pages from the GNU Core Utilities (#2213)
    • Create all missing pages from util-linux (#2214)
    • Create all missing pages from the "Who needs a GUI?" article (#1162)
    • Bonus: Create pages for the individual "page request" issues marked with the help wanted label.
    • Bonus: Implement an automated check to test and report coverage against lists (#1070)
  • Required skills: Interpreting manpages; experimenting with CLI tools (possibly in multiple systems)
  • Difficulty: easy/medium
  • Potential mentors: @sbrl

Add links to all existing pages

  • Summary: Pages now support adding a link to the tool's homepage, but many are still lacking it. The goal of this project is to ensure all pages have a link that people can follow to learn more about the tool and explore more comprehensive documentation. For reference, see the following PRs where multiple links have been added:
    • #2660
    • #2684
  • Required skills: Web research, basic GitHub skills
  • Difficulty: easy
  • Potential mentors: @sbrl
Clone this wiki locally