Anton Melnikov
75146e032c
docs: suggestions from code review
...
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2025-06-25 15:30:06 +02:00
botantony
0dc48348af
docs: add autobump-related documentation
...
Signed-off-by: botantony <antonsm21@gmail.com>
2025-06-23 15:06:37 +02:00
Eric Knibbe
d4c02e64e5
Cask-Cookbook: reorder some sections
2025-05-20 10:30:24 -04:00
Eric Knibbe
e8a0142150
Cask-Cookbook: review and update
...
with suggestions from code review
Co-Authored-By: Klaus Hipp <khipp@users.noreply.github.com>
Co-Authored-By: Bevan Kay <email@bevankay.me>
2025-05-20 10:30:24 -04:00
Eric Knibbe
2b25f34e85
Cask-Cookbook: mention replacement_formula/cask
2025-05-20 10:30:24 -04:00
Eric Knibbe
3320d7ee3e
Cask-Cookbook: mention version.csv methods
2025-05-20 10:30:24 -04:00
Eric Knibbe
ad5e03279b
Cask-Cookbook: relocate and update script: key lists
2025-05-20 10:30:24 -04:00
Eric Knibbe
0838ceda90
cask: document shell completion stanzas
...
Also, allow them to be given a `target:` parameter.
2025-05-09 14:47:26 -04:00
Eric Knibbe
29b2f35ce8
docs: prefer /opt/homebrew in examples
2025-02-03 15:30:03 +01:00
Issy Long
31d7bcc583
Add a last_reviewed_date to docs metadata
...
- At the AGM we formed an ad-hoc documentation working group.
- One of our ideas was that we should have a last reviewed date for
documentation, so that we can periodically implement a review
mechanism (GitHub Actions posts to Slack for a regular documentation
outdatedness check?) to track how old docs are and ensure they're
still relevant.
- This is a first step towards that goal, by adding a `last_review_date`
to the metadata of all docs with a date of earlier than Homebrew's
inception because everything needs reviewing so that we start from a
good base!
2025-02-03 11:56:07 +00:00
Patrick Linnane
f260980f57
Cask-Cookbook: update verified example
...
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2024-09-25 17:52:31 -07:00
Patrick Linnane
773dbfa92a
docs: update for Homebrew/cask-fonts deprecation
...
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2024-05-16 09:21:14 -07:00
Bevan Kay
a52b179164
docs linting
2024-05-03 23:02:37 +10:00
Bevan Kay
7239bcc04b
docs/cask-cookbook: provide token examples for versioned/development casks
2024-05-03 22:54:07 +10:00
Patrick Linnane
92a43a6465
Cask-Cookbook: remove outdated URL
...
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2024-05-02 17:13:20 -07:00
Patrick Linnane
e4f7618545
docs: update for Homebrew/cask-versions deprecation
...
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2024-05-02 14:40:07 -07:00
Aaron Liu
db12a9c4ae
Docs: the deleted → be deleted
2024-02-11 14:47:32 -05:00
Mike McQuaid
f09ea3a472
Merge pull request #16583 from dnicolson/fix-quick-look-2
...
Replace “QuickLook” with “Quick Look”
2024-02-04 17:55:54 +01:00
Dave Nicolson
4d9496831d
Replace “QuickLook” with “Quick Look”
2024-02-04 16:30:03 +01:00
Issy Long
e5ae67f906
Fix RuboCop FormulaAudit/ group offenses for docs code examples
2024-01-24 00:01:44 +00:00
Issy Long
9b6903f50b
Fix RuboCop Style/ group offenses in docs example code
2024-01-24 00:01:43 +00:00
Issy Long
af90f0858a
Fix RuboCop Layout/ group offenses in docs example code
2024-01-24 00:01:42 +00:00
Issy Long
28c513ac9d
Fix basic Ruby syntax errors in docs example code
...
- Blocks should open with `do` and close with `end`.
- `...` is not valid Ruby syntax, so comment it out so that the user
knows that it's a placeholder for "other things here".
- Reword the "header line details" in `Cask-Cookbook` otherwise RuboCop
crashes even with an `end` because of the empty block. There was
already an example of a valid header line in the first code block on
the page, so it's not a big loss.
2024-01-24 00:01:39 +00:00
Bevan Kay
bd6ab1d2b8
cask/uninstall: skip quit and signal directives when upgrading or reinstalling
2024-01-19 23:30:25 +11:00
Rylan Polster
2a1a54c58a
Add deprecate! and disable! to cask docs
2023-12-17 19:59:53 -05:00
Razvan Azamfirei
cbe2c1d5c5
docs: update documentation
2023-12-15 15:49:05 -05:00
apainintheneck
2030f07132
Fix markdown linter errors
...
v0.13 of the `markdownlint` gem just got released and it has
a few new rules which are docs ended up failing. This fixes
those linter errors so that CI is no longer red.
Rules:
MD055 - Tables: Each row must start and end with a '|'
MD057 - Tables: In the second row every column must have at least '---',
possibly surrounded with alignment ':' chars
2023-10-02 22:42:39 -07:00
Eric Knibbe
9372edf38f
docs: re-case titles
2023-09-11 02:26:37 -04:00
Eric Knibbe
931f762598
docs+rubydoc: various grammar/wording fixes
2023-09-11 02:26:37 -04:00
Eric Knibbe
6dfacae5d2
docs/Cask-Cookbook: more on_<system> improvements
2023-09-05 00:37:16 -04:00
Eric Knibbe
4205cb495a
docs: rework Cask-Cookbook to match current practice
...
and migrate `livecheck` stanza documentation to Brew-Livecheck.md
2023-09-02 00:43:51 -04:00
Eric Knibbe
217ebf88c7
remove OSDN link due to site unreliability
2023-09-01 00:27:05 -04:00
Amy Grace
edf022d94e
docs: update formula and cask URLs to new sharded format
2023-08-26 14:54:19 +01:00
Bo Anderson
67ecc2452a
Merge pull request #15602 from donaldducky/cask-support-multiple-headers
...
Cask support multiple headers
2023-07-20 21:19:55 +01:00
Patrick Linnane
c56669e9cd
various: fix miscellaneous typos
2023-07-18 08:52:49 -07:00
Bevan Kay
6a78d5833b
docs/cask: replace single-quoted with double-quoted
2023-07-17 12:52:15 +10:00
Don Chea
0e9a8418fc
Update Cask cookbook to mention header array support
2023-06-28 11:36:12 -04:00
Razvan Azamfirei
5192866abe
homebrew-cask-drivers: deprecate official tap
2023-06-08 08:12:59 -04:00
EricFromCanada
819bef620c
docs: deprecate appcast
2023-04-16 09:01:12 -04:00
EricFromCanada
b9dab243b5
cask/artifact: fix up some definitions
...
And expand the list of artifacts that target: works with.
2023-04-14 15:47:33 -04:00
EricFromCanada
94afe6938a
docs: mention keyboard_layout for casks
2023-03-30 18:43:31 -04:00
Mike McQuaid
b3684e55a7
Merge pull request #14997 from ZhongRuoyu/ventura-system-settings
...
Update path to system settings on Ventura
2023-03-17 15:45:05 -04:00
stevenlele
b1ddbfee22
Remove redundant comma in docs
2023-03-17 20:38:26 +08:00
stevenlele
c5973022d4
Update tag order in docs
2023-03-17 20:34:25 +08:00
Ruoyu Zhong
e9ce4a5a4e
Update path to system settings on Ventura
...
"System Preferences" has been renamed to "System Settings" on Ventura.
Privacy and security settings have moved, too. This commit makes sure
these changes are reflected. (Some adjustments were already made in
#14092.)
Signed-off-by: Ruoyu Zhong <zhongruoyu@outlook.com>
2023-03-17 19:24:07 +08:00
Markus Reiter
fa9d8057ab
Tweak version :latest docs.
2023-02-08 19:07:21 +01:00
EricFromCanada
42e91e8668
docs: add Table of Contents to selected pages
2022-12-30 00:45:30 -05:00
EricFromCanada
91c71a58ac
Cask-Cookbook: content & formatting updates
2022-11-11 16:07:11 -05:00
EricFromCanada
9c22c47e4f
Cookbooks: adjust line breaks
2022-11-11 15:49:53 -05:00
Patrick Linnane
2c550684e3
Update docs/Cask-Cookbook.md
...
Co-authored-by: Bo Anderson <mail@boanderson.me>
2022-11-04 18:10:46 -07:00
