From 231dc560a96efdd8d365c731d7d91c541020d77c Mon Sep 17 00:00:00 2001 From: Managor <42655600+Managor@users.noreply.github.com> Date: Mon, 21 Jul 2025 19:40:44 +0300 Subject: [PATCH] style-guide: add page naming instructions (#17299) Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com> --- contributing-guides/style-guide.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/contributing-guides/style-guide.md b/contributing-guides/style-guide.md index 746142ece3..277f203df7 100644 --- a/contributing-guides/style-guide.md +++ b/contributing-guides/style-guide.md @@ -117,6 +117,8 @@ most [tldr pages clients](https://github.com/tldr-pages/tldr/wiki/Clients) will In this case, the information of the Windows version of `cd` (stored in `pages/windows/cd.md`) will be displayed by default to Windows users, and a generic/common version (stored in `pages/common/cd.md`) will be displayed for Linux, macOS, and other platform users. +Try to match the page filename with the invoked command. Do not use the project name if possible. The goal is to be as transparent as possible to the user when they are curious of a command. + ### Aliases If a command can be called with alternative names (like `vim` can be called by `vi`), alias pages can be created to point the user to the original command name.