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

Part of set-of-tools #11969

Open
vitorhcl opened this issue Jan 1, 2024 · 1 comment
Open

Part of set-of-tools #11969

vitorhcl opened this issue Jan 1, 2024 · 1 comment
Labels
decision A (possibly breaking) decision regarding tldr-pages content, structure, infrastructure, etc. documentation Issues/PRs modifying the documentation.

Comments

@vitorhcl
Copy link
Member

vitorhcl commented Jan 1, 2024

There are many pages that contain a "> Part of set-of-tools.", it is kinda informal convention. It would be nice to properly document it. Some questions:

  • Would "set-of-tools" need to be enclosed with backticks? For example, ImageMagick tools have "Part of ImageMagick"
  • Does every page needs this or only when it isn't clear?
  • If it isn't required, is there a need to mantain the consistency on this across every command of a given set of tools?
@vitorhcl vitorhcl added documentation Issues/PRs modifying the documentation. decision A (possibly breaking) decision regarding tldr-pages content, structure, infrastructure, etc. labels Jan 1, 2024
@kbdharun
Copy link
Member

kbdharun commented Jan 1, 2024

We generally follow this on Let's Document pages (where there isn't anything additional to write in the second line, sometimes when there is too), but I agree that we can document this in the style guide.

Would "set-of-tools" need to be enclosed with backticks? For example, ImageMagick tools have "Part of ImageMagick"

If we highlight the project name then it shouldn't be enclosed in backticks or else for subcommand pages it is indeed suggested to enclose it in backticks.

Does every page needs this or only when it isn't clear?

It depends, we generally use it when it's required (or when there is a free description in the page)

If it isn't required, is there a need to mantain the consistency on this across every command of a given set of tools?

Not really sure tbh, in some commands we add additional notes/sub points whereas we use this as a filler in other pages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
decision A (possibly breaking) decision regarding tldr-pages content, structure, infrastructure, etc. documentation Issues/PRs modifying the documentation.
Projects
None yet
Development

No branches or pull requests

2 participants