Patrick Linnane
8567e8bcd3
docs: clarify listed archive formats aren't exclusive
...
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2025-09-12 09:15:47 -07:00
Rylan Polster
5d13ce9280
Remove unused cask url do code
2025-08-23 15:02:23 -04:00
Mike McQuaid
d13aaf94db
Deprecate conflicts_with formula: in Cask DSL.
...
This is outside of our usual deprecation process but it's a no-op method
that does, and has always done, nothing so it doesn't make sense to wait
another 2.5 months before deprecating it.
While we're here, make `conflicts_with` `typed: strict` in Sorbet.
2025-08-18 19:25:54 +01:00
Eric Knibbe
de3cebf45c
docs: edit various URLs
2025-08-16 23:33:38 -04:00
Bevan Kay
0bb269fdf0
docs/cask: add rename stanza docs
2025-08-12 23:24:20 +10:00
AltCode
58884c1fac
docs: apply suggestions from code review
...
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2025-08-07 14:25:20 +02:00
AltCode
360ff196c4
docs: improve Autobump documentation
2025-08-06 19:15:24 +02:00
Mike McQuaid
f1e458a36a
Merge pull request #20117 from botantony/no_autobump
...
docs: add autobump related documentation
2025-06-25 15:27:51 +00:00
Anton Melnikov
75146e032c
docs: suggestions from code review
...
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2025-06-25 15:30:06 +02:00
Mike McQuaid
55f65ec375
audit: ensure that official formula and cask names don't conflict.
...
Co-authored-by: Eric Knibbe <enk3@outlook.com>
2025-06-23 16:08:13 +01: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
