mirror of
https://github.com/Homebrew/brew.git
synced 2026-08-12 22:29:27 +04:00
Douglas Eichelberger
b81e00685f
The Documentation workflow installs Vale unpinned, and 3.17.0 reports two errors that 3.16.0 did not, so every pull request built after its release fails the docs job on unchanged content. Both are real violations of our own styles rather than new false positives. Drop an Oxford comma in the conference reimbursement list, and link to How-To-Open-a-Homebrew-Pull-Request.md by the name Homebrew.Terms exempts, which is also how every other page refers to it.
103 lines
4.4 KiB
Markdown
103 lines
4.4 KiB
Markdown
---
|
|
last_review_date: "2026-07-18"
|
|
---
|
|
|
|
Start with [installation](Installation.md),
|
|
[`man brew`](Manpage.md),
|
|
[troubleshooting](Troubleshooting.md) and
|
|
[FAQ (Frequently Asked Questions)](FAQ.md) guides if you are new to Homebrew.
|
|
|
|
Documentation is grouped below by audience: users, contributors, maintainers and those interested in Homebrew's governance.
|
|
|
|
## Users
|
|
|
|
- [`brew` manual page (command documentation, also available with `man brew`)](Manpage.md)
|
|
- [Homebrew Blog (news on major updates)](https://brew.sh/blog/)
|
|
- [Installation](Installation.md)
|
|
- [Support Tiers](Support-Tiers.md)
|
|
- [Troubleshooting](Troubleshooting.md)
|
|
- [FAQ (Frequently Asked Questions)](FAQ.md)
|
|
- [Common Issues](Common-Issues.md)
|
|
- [`brew` Shell Completion](Shell-Completion.md)
|
|
- [Command Not Found](Command-Not-Found.md)
|
|
- [Homebrew on Linux](Homebrew-on-Linux.md)
|
|
- [Homebrew Bundle, `brew bundle` and `Brewfile`](Brew-Bundle-and-Brewfile.md)
|
|
- [Homebrew MCP Server](MCP-Server.md)
|
|
|
|
- [Bottles (binary packages)](Bottles.md)
|
|
- [Taps (third-party repositories)](Taps.md)
|
|
- [Trusting Taps](Tap-Trust.md)
|
|
- [Homebrew Security and Supply Chain](Homebrew-Security-and-Supply-Chain.md)
|
|
- [Interesting Taps and Forks](Interesting-Taps-and-Forks.md)
|
|
- [Tips and Tricks](Tips-and-Tricks.md)
|
|
- [Anonymous Analytics](Analytics.md)
|
|
|
|
- [Querying `brew`](Querying-Brew.md)
|
|
- [C++ Standard Libraries](C%2B%2B-Standard-Libraries.md)
|
|
- [Custom GCC and Cross-Compilers](Custom-GCC-and-cross-compilers.md)
|
|
- [External Commands](External-Commands.md)
|
|
- [Language Runtimes and Packages](Language-Runtimes-and-Packages.md)
|
|
- [Building Software with Homebrew Keg-Only Dependencies](How-to-Build-Software-Outside-Homebrew-with-Homebrew-keg-only-Dependencies.md)
|
|
|
|
- [Creating a Homebrew Issue](Creating-a-Homebrew-Issue.md)
|
|
- [Updating Software in Homebrew](Updating-Software-in-Homebrew.md)
|
|
- [Adding Software to Homebrew](Adding-Software-to-Homebrew.md)
|
|
|
|
## Contributors
|
|
|
|
- [How to Open a Homebrew Pull Request (and get it merged)](How-To-Open-a-Homebrew-Pull-Request.md)
|
|
- [Responsible AI Usage](Responsible-AI-Usage.md)
|
|
- [Working with Homebrew as an Upstream Project](Working-with-Homebrew-as-an-Upstream-Project.md)
|
|
- [Formula Cookbook](Formula-Cookbook.md)
|
|
- [Cask Cookbook](Cask-Cookbook.md)
|
|
- [Acceptable Formulae](Acceptable-Formulae.md)
|
|
- [Acceptable Casks](Acceptable-Casks.md)
|
|
- [Package Acceptance Policy](Package-Acceptance-Policy.md)
|
|
- [Licence Guidelines](Licence-Guidelines.md)
|
|
- [Checksum Requirements](Checksum-Requirements.md)
|
|
- [Formulae Versions](Versions.md)
|
|
- [Deprecating, Disabling and Removing](Deprecating-Disabling-and-Removing.md)
|
|
- [Language-Specific Formulae](Language-Specific-Formulae.md)
|
|
- [`brew livecheck`](Brew-Livecheck.md)
|
|
- [Autobump](Autobump.md)
|
|
- [Migrating a Formula to a Tap](Migrating-A-Formula-To-A-Tap.md)
|
|
- [Renaming a Formula](Rename-A-Formula.md)
|
|
- [Building Against Non-Homebrew Dependencies](Building-Against-Non-Homebrew-Dependencies.md)
|
|
- [How to Create and Maintain a Tap](How-to-Create-and-Maintain-a-Tap.md)
|
|
- [BrewTestBot](BrewTestBot.md)
|
|
- [Prose Style Guidelines](Prose-Style-Guidelines.md)
|
|
- [Type Checking with Sorbet](Typechecking.md)
|
|
- [Reproducible Builds](Reproducible-Builds.md)
|
|
|
|
- [Ruby API Documentation](/rubydoc/index.html) (e.g. for `Formula`, `Cask` etc.)
|
|
|
|
## Maintainers
|
|
|
|
- [New Maintainer Checklist](New-Maintainer-Checklist.md)
|
|
- [Maintainers: Avoiding Burnout](Maintainers-Avoiding-Burnout.md)
|
|
|
|
- [Maintainer Guidelines](Maintainer-Guidelines.md)
|
|
- [Homebrew/brew Maintainer Guide](Homebrew-brew-Maintainer-Guide.md)
|
|
- [Homebrew/homebrew-core Maintainer Guide](Homebrew-homebrew-core-Maintainer-Guide.md)
|
|
- [Homebrew/homebrew-cask Maintainer Guide](Homebrew-homebrew-cask-Maintainer-Guide.md)
|
|
|
|
- [BrewTestBot for Maintainers](BrewTestBot-For-Maintainers.md)
|
|
- [Common Issues for Maintainers](Common-Issues-for-Maintainers.md)
|
|
- [Releases](Releases.md)
|
|
|
|
- [Linux CI](Linux-CI.md)
|
|
- [Xcode](Xcode.md)
|
|
|
|
## Governance
|
|
|
|
- [Homebrew Governance](Homebrew-Governance.md)
|
|
- [Homebrew Leadership Responsibilities](Homebrew-Leadership-Responsibilities.md)
|
|
- [Homebrew Governance Archives](Homebrew-Governance-Archives.md)
|
|
- [Homebrew's Expense and Reimbursement Policy](Expense-and-Reimbursement-Policy.md)
|
|
- [How To Organise the Homebrew AGM](How-To-Organise-the-AGM.md)
|
|
- [Homebrew's Maintainer Stipends and Grants](Maintainer-Stipends-and-Grants.md)
|
|
|
|
## Project history
|
|
|
|
- [Kickstarter Supporters](Kickstarter-Supporters.md)
|