Season of Docs projects

The following are some ideas for potential projects to submit to the Season of Docs program.

Content projects

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

• Summary: There are currently three lists of clients, each maintained independently. We want the client lists to live at a single place, so that the lists won't get out of sync nor outdated. The goal is to merge the three lists without losing any relevant information, but keeping it readable. The final list can live at either of the three existing places, or at a new location (e.g. a new CLIENTS.md file). The existing locations should either embed or link to the unified list.
  Links to the existing lists:
  • README: https://github.com/tldr-pages/tldr/blob/master/README.md#clients
  • Wiki: https://github.com/tldr-pages/tldr/wiki/TLDR-clients
  • Website: https://tldr.sh/#installation
• Required skills: markdown formatting; git(hub)
• Difficulty: easy
• Potential mentors: @waldyrious

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:
  • ...
  • ...
  • ...
• Required skills: Web research
• Difficulty: easy
• Potential mentors:

Coding projects

Implement multi-language support for the node client

• Summary: The node client does not have the ability to show pages from different languages. We already have the translated pages in our repo. The client just needs to consume the language info and show the correct page. Please see https://github.com/tldr-pages/tldr/blob/master/CLIENT-SPECIFICATION.md#language for more info on how to consume this information.
• Required skills: Node.js, JavaScript
• Difficulty: easy
• Potential mentors: @agnivade

Convert the linter from lex/yacc to a more popular language

• Summary: Convert our current unmaintainable linter into something that's more maintainable and understood by more people. It is suggested that this npm package be investigated as a starting point, but using JavaScript is not required.
• Required skills: knowledge of lexing/parsing (very useful)
• Difficulty: challenging
• Potential mentors: @sbrl