5e6dc70b2c
style-guide: organize content and update sections; *: fix Markdownlint errors ( #12148 )
...
* style-guide: organize content and add contents section
* style-guide: fix general writing section title
* style-guide: fix heading level of help and version commands
* style-guide: fix heading level of see also section
* cleanup: update files
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
* contributing: fix page for markdown lint
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
* fix: markdownlint errors across files
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
* docs: improve documentation about keycaps
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
* docs: add info about optional and string placeholders
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
* cleanup: sync changes with recent versions of style guide
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
* cleanup: update style guide
Co-authored-by: Vítor Henrique <87824454+vitorhcl@users.noreply.github.com>
* docs: update style guide
Co-authored-by: Vítor Henrique <87824454+vitorhcl@users.noreply.github.com>
* docs/style-guide: reword more info links section
Co-authored-by: Vítor Henrique <87824454+vitorhcl@users.noreply.github.com>
---------
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2024-04-22 09:20:17 +05:30
21ad18714b
cleanup/style guide: update descriptions section ( #12313 )
...
* cleanup/style guide: update descriptions section
* style-guide: merge branch #12304 into descriptions section
* style-guide: rename Descriptions/Style to Formatting
* style-guide: replace "brand project names" with "proper names"
Co-authored-by: Juri Dispan <juri.dispan@posteo.net>
* style-guide: apply suggestions from code review
Co-authored-by: Starbeamrainbowlabs <sbrl@starbeamrainbowlabs.com>
---------
Co-authored-by: Juri Dispan <juri.dispan@posteo.net>
Co-authored-by: Starbeamrainbowlabs <sbrl@starbeamrainbowlabs.com>
2024-03-14 12:33:09 -03:00
5da4cacd9c
style-guide: update page ( #12304 )
...
* style-guide: update page
---------
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Co-authored-by: Vitor Henrique <87824454+vitorhcl@users.noreply.github.com>
Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
2024-02-23 16:33:59 +05:30
c7868a7c9c
style-guide: recommend keith.github.io for osx pages ( #12097 )
...
* style-guide: recommend keith.github.io for osx pages
---------
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2024-01-22 09:43:24 +05:30
320d0e7f0e
style-guide: clarify available man pages on manned.org ( #12096 )
2024-01-21 12:48:40 +05:30
6e6041644a
style-guide: use "berkas" instead of "file" in Indonesian translations ( #12083 )
2024-01-19 14:54:04 +05:30
69693b3c80
style-guide: document conjugation of descriptions in Spanish ( #11995 )
...
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2024-01-04 17:29:35 +01:00
c752d19374
style-guide: add emphasis section ( #11971 )
...
Co-authored-by: Juri Dispan <juri.dispan@posteo.net>
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
2024-01-03 15:19:45 +01:00
a9f7c8fcba
style-guide: add documentation for "See also" links ( #11868 )
...
Co-authored-by: Vitor Henrique <87824454+vitorhcl@users.noreply.github.com>
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-12-31 13:57:47 +01:00
161f26d045
cleanup: update style guide ( #11860 )
...
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
2023-12-28 17:31:20 +01:00
793d2a47c2
style-guide: add help and version commands section ( #11854 )
...
* style-guide: add help and version commands section
* style-guide: minor fixes to help & version command section wording
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
---------
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-12-27 15:13:32 +05:30
afb9b61f9c
style-guide: add Portuguese specific rules ( #11770 )
...
style-guide: add Portuguese-Specific Rules
2023-12-17 01:44:48 -03:00
f9606bbcc5
style-guide: modify grouping placeholders section ( #11723 )
2023-12-12 05:33:35 +01:00
2793c40467
style-guide: fix list
...
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-12-04 21:26:19 +00:00
b6b3520d72
style-guide: fix typo
2023-12-04 21:26:19 +00:00
81b01c8c6b
style-guide: update page
...
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-12-04 21:26:19 +00:00
9933b7bdd8
style-guide: clarify mnemonic guidelines
2023-12-04 21:26:19 +00:00
4a1f8a8012
Update contributing-guides/style-guide.md
2023-12-04 21:26:19 +00:00
eab7e5cdcb
Update contributing-guides/style-guide.md
...
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
2023-12-04 21:26:19 +00:00
4fec07719d
style-guide: clarify PowerShell range validation
2023-12-04 21:26:19 +00:00
e884d83b07
style-guide: add mnemonic translations
2023-12-04 21:26:19 +00:00
67f90450a4
style-guide: add mnemonic translations
2023-12-04 21:26:19 +00:00
8b8a2d2de0
style-guide: fix missing PowerShell alias types
2023-12-04 21:26:19 +00:00
584688c0c9
style-guide: add short option mnenonics, and windows- and powershell-specific rules
2023-12-04 21:26:19 +00:00
fdca74b9b4
style-guide: fix typo ( #11516 )
2023-11-16 00:28:40 +01:00
54a5de5b6d
style-guide: add and update documentation about URLs ( #11320 )
...
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-10-30 10:19:41 +01:00
aba00dfa4c
style-guide: add Indonesian-specific guidelines ( #10987 )
...
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-10-25 21:28:11 +02:00
9ced683c99
style-guide: add guidelines for standard streams; fix remaining pages ( #11196 )
...
* readonly, {un,}compress, zbarcam: use proper syntax for IO streams
* style-guide: add guidelines for standard streams
* duckdb, perl: add backticks around stdin and stdout
2023-10-24 06:55:09 +05:30
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
5afb6ec14e
style-guide: add guidelines for `--opt arg`, improve wording ( #10906 )
2023-10-11 09:57:23 +02:00
6e0a21c58b
krita: move to `common`, update description; style-guide: add description guidelines ( #10858 )
2023-10-09 19:12:47 +07:00
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
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
5fd383d53f
Use `n` instead of `infinity` ( #9759 )
2023-01-11 23:49:41 +10:00
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
0239f5de94
style-guide.md: refresh page ( #9709 )
...
* Restrict alternatvie count to 5
* Enhance grammar
2023-01-06 22:51:40 +10:00
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
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
fe3338e6aa
style-guide.md: fix broken path placeholders ( #9641 )
2022-12-20 07:27:00 -03:00
ff14fd5fd5
Replace `token` with `placeholder` ( #9529 )
2022-12-13 14:23:03 +10:00
3a540d3b3f
style-guide: fix typo in Option syntax ( #9603 )
2022-12-09 09:18:31 +05:30
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
cae5ae7058
style-guide: refresh page ( #8858 )
2022-10-16 05:08:39 +05:30
9c1754e077
style-guide: add French verb tense guideline ( #8700 )
2022-10-08 22:40:17 +08:00
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
35b015a0b4
fix: wrong hyphen instead of backtrack in style-guide ( #8397 )
2022-08-24 19:33:49 +00:00
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
1164cabae7
style-guide: add information about links ( #7842 )
2022-03-07 09:45:12 -03:00
ac76c79295
style-guide: mention tldr-lint instead of tldrl ( #7495 )
2021-12-10 07:01:34 -03:00
812ebcca53
style-guide: add imperative mood rule ( #6816 )
2021-10-13 17:53:19 +02:00
Vítor Henrique
K.B.Dharun Krishna
Reinhart Previano Koentjoro
Alejandro Cervera
Juri Dispan
Sebastiaan Speck
Magrid
Lena
Emily Grace Seville
Mia Combeau
Cornelius Roemer
Emily Grace Seville
git-em
marchersimon