Lena
7856124245
docs: use the new `[!NOTE]` syntax ( #10959 )
...
* style-guide: use the new note syntax
* MAINTAINERS: use the new note syntax, use full month names
* CONTRIBUTING: use the new note syntax
* maintainers-guide: use the new note syntax
* CLIENT-SPECIFICATION: use the new note syntax
* COMMUNITY-ROLES: use the new note syntax
* git-terminal: use the new note syntax
---------
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-10-13 01:26:58 +02:00
Lena
5afb6ec14e
style-guide: add guidelines for `--opt arg`, improve wording ( #10906 )
2023-10-11 09:57:23 +02:00
Lena
6e0a21c58b
krita: move to `common`, update description; style-guide: add description guidelines ( #10858 )
2023-10-09 19:12:47 +07:00
K.B.Dharun Krishna
2135714193
pages/*, style-guide: update contents, fix Markdown ( #10492 )
...
* pages/*, style-guide: update pages, fix Markdown (commit 1)
* Update pages
* style-guide.de: update page
* Apply suggestions from code review
Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
* Apply suggestions from code review
Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
* pip3: remove search command
* rpm: update path placeholder
Co-authored-by: pixel <pixel+github@chrissx.de>
* Update pages/linux/pkgfile.md
Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
---------
Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
Co-authored-by: pixel <pixel+github@chrissx.de>
2023-08-26 23:00:06 +05:30
Emily Grace Seville
6b405eb7e0
Remove rules for ranges and options ( #9793 )
...
* Remove rules for ranges and options
* Return "Option syntax"
2023-02-09 07:47:56 +05:30
Emily Grace Seville
5fd383d53f
Use `n` instead of `infinity` ( #9759 )
2023-01-11 23:49:41 +10:00
Emily Grace Seville
0284c2390a
style-guide: refresh page: move ellipsis to a separate section and extend syntax ( #9742 )
...
* Move and reword ellipsis to a separate section
* Add notes about grouping placeholders
* Permit specifing repetition count for placeholders
* Mandate using simplified range syntax for ellipsis
* Update contributing-guides/style-guide.md
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
* Remove redundant note
* Refresh repetition syntax for ellipsis
* Don't allow restrict repetition count via ellipsis
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-01-10 09:54:53 +08:00
Emily Grace Seville
0239f5de94
style-guide.md: refresh page ( #9709 )
...
* Restrict alternatvie count to 5
* Enhance grammar
2023-01-06 22:51:40 +10:00
Emily Grace Seville
ee0a2809ea
style-guide: refresh page ( #9718 )
...
* Move `Range syntax` to `Placeholder syntax` chapter
* Require generic placeholders when available
* Require ranges just for singular arguments
* style-guide: update grammar
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
* style-guide: update spacing in Chinese-Specific Rules
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
* style-guide: fix typos, spacing
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-01-03 22:08:49 +05:30
Emily Grace Seville
2190f4031f
style-guide: add Range syntax ( #9646 )
...
* style-guide: standardize range syntax
* Simplify syntax for arbitraty integer placeholders
* Describe syntax for arbitraty floats
2023-01-03 13:44:04 +10:00
Emily Grace Seville
fe3338e6aa
style-guide.md: fix broken path placeholders ( #9641 )
2022-12-20 07:27:00 -03:00
Emily Grace Seville
ff14fd5fd5
Replace `token` with `placeholder` ( #9529 )
2022-12-13 14:23:03 +10:00
K.B.Dharun Krishna
3a540d3b3f
style-guide: fix typo in Option syntax ( #9603 )
2022-12-09 09:18:31 +05:30
Emily Grace Seville
92623218aa
style-guide.md: write rules for short/long options ( #9527 )
...
* Write rules for short/long options
* Apply suggestions from code review
* Update contributing-guides/style-guide.md
* Remove note about `common/`
* Reword note about GNU style options
2022-12-08 16:27:26 +10:00
K.B.Dharun Krishna
cae5ae7058
style-guide: refresh page ( #8858 )
2022-10-16 05:08:39 +05:30
Mia Combeau
9c1754e077
style-guide: add French verb tense guideline ( #8700 )
2022-10-08 22:40:17 +08:00
K.B.Dharun Krishna
1bb198bc94
style-guide: fix links ( #8496 )
...
* style-guide: fix links
* Fix Pre-translated alias page templates line
2022-09-19 08:14:20 +05:30
Cornelius Roemer
35b015a0b4
fix: wrong hyphen instead of backtrack in style-guide ( #8397 )
2022-08-24 19:33:49 +00:00
Emily Grace Seville
11f4bd15b1
style-guide: refresh layout info ( #7951 )
...
* Add info about alias pages
* Refresh `Layout` chapter:
- add syntax highlighting
- better placeholders
* Better placeholders in `Aliases`
* Fix placeholders and formatting
* Use snake case
Co-authored-by: CleanMachine1 <78213164+CleanMachine1@users.noreply.github.com>
* Rewording in alias chapter
Co-authored-by: CleanMachine1 <78213164+CleanMachine1@users.noreply.github.com>
* Enhance placeholder syntax used in:
- layout
- aliases
* Format placeholder tip in `Layout`
* Generalize help page url and add note
* Mention tutorials and prefer docs
* Better placeholders: use `{{}}` everywhere
* Don't use {{ }}
* Add examples
* Fix second note in `Layout`
* Add blank line in quote to reduce linter warnings
* Don't trim trailing spaces
* Update contributing-guides/style-guide.md
Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com>
* Removes spaces restored
* Reword 'it takes more attention to copywriting'
* Better grammar
Co-authored-by: Starbeamrainbowlabs <sbrl@starbeamrainbowlabs.com>
* Use `command` instead of `code`
Co-authored-by: CleanMachine1 <78213164+CleanMachine1@users.noreply.github.com>
* Remove note from `Layout` chapter
* Simplify page template
* Rephrase sentences and update placeholders
Co-authored-by: marchersimon <50295997+marchersimon@users.noreply.github.com>
* style-guide: update page title in example page
Co-authored-by: marchersimon <50295997+marchersimon@users.noreply.github.com>
Co-authored-by: CleanMachine1 <78213164+CleanMachine1@users.noreply.github.com>
Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com>
Co-authored-by: Starbeamrainbowlabs <sbrl@starbeamrainbowlabs.com>
Co-authored-by: marchersimon <50295997+marchersimon@users.noreply.github.com>
2022-07-20 01:08:47 +01:00
git-em
1164cabae7
style-guide: add information about links ( #7842 )
2022-03-07 09:45:12 -03:00
marchersimon
ac76c79295
style-guide: mention tldr-lint instead of tldrl ( #7495 )
2021-12-10 07:01:34 -03:00
marchersimon
812ebcca53
style-guide: add imperative mood rule ( #6816 )
2021-10-13 17:53:19 +02:00
Janek
ec4a9a4ee6
style-guide: put token guidelines into sections & add varargs ( #6200 )
2021-09-12 16:01:45 +02:00
lincc
e389e9793c
style-guide: add one Chinese-specific rule ( #6374 )
2021-08-31 23:26:01 +08:00
lincc
0c4c907748
style-guide: add Chinese-specific rules ( #6285 )
2021-08-06 19:31:33 +02:00
Seth Falco
cabd356464
style-guide: add section on serial comma ( #6256 )
2021-07-25 21:17:28 +01:00
Axel Navarro
78570a4432
style-guide: clarify that any client may have --render ( #5915 )
2021-06-23 14:36:44 +01:00
Owen Voke
a66723d2c5
docs: update references to 'main' branch
2021-05-01 20:10:05 +01:00
Agno94
a108e73ce3
contributing-guides/style-guide: add block device rules ( #5036 )
2021-03-29 14:21:55 +02:00
Lucas Gabriel Schneider
8f3b999ed7
remove keyboard shortcuts from backticks guide
2021-01-31 16:21:16 +00:00
Lucas Gabriel Schneider
a1cfa7afd3
removed ports from backtick guide
2021-01-31 16:21:16 +00:00
Lucas Gabriel Schneider
c3bbc30f28
Unify filenames and directories
2021-01-31 16:21:16 +00:00
Lucas Gabriel Schneider
d929a3914b
Update contributing-guides/style-guide.md
...
Co-authored-by: Axel Navarro <navarroaxel@gmail.com>
2021-01-31 16:21:16 +00:00
lucas schneider
6011cd2a2f
fix missing .
2021-01-31 16:21:16 +00:00
lucas schneider
e5a0509537
remove unnecessary newlines
2021-01-31 16:21:16 +00:00
lucas schneider
e4733f650c
style guide: add backtick syntax
2021-01-31 16:21:16 +00:00
Waldir Pimenta
37634b36f7
Harmonize project name (lowercase tldr, no semicolon, hyphen-separated)
2020-05-27 22:22:32 +02:00
fejx
4e1662b729
Change all occurrences of file_name to filename ( #4059 )
2020-05-22 09:31:24 -03:00
Zlatan Vasović
2baf68336b
Avoid title case ( #3716 )
2020-04-19 12:14:52 +02:00
Owen Voke
5552f4bc6a
style guide: update wording of the page link ( #3060 )
2019-05-30 22:07:00 +02:00
Owen Voke
a224d6dee9
style-guide and PR template: add web link guidelines to checklists ( #3030 )
2019-05-18 17:43:29 +02:00
Marco Bonelli
872f716fdc
Style guide: change "folder" to "directory".
2019-02-08 19:43:24 +00:00
Colin
c93f4b96f5
style-guide.md: add tip to view file locally ( #1928 )
2018-01-30 11:45:22 +05:30
Waldir Pimenta
f8c7dfc0c7
docs overhaul: move auxiliary documentation to a separate folder
2017-11-28 09:01:47 +05:30