brew/docs/README.md

---
last_review_date: "1970-01-01"
---

# Homebrew Docs

These are the source files for the [Homebrew documentation site](https://docs.brew.sh/).

A [GitHub Action](https://github.com/Homebrew/brew/blob/master/.github/workflows/docs.yml) is run to validate each change before the site is deployed to GitHub Pages.

## Usage

Open <https://docs.brew.sh> in your web browser.

To instead generate the site locally, available on localhost:4000, run:

```bash
cd `brew --repository`/docs
bundle install
bundle exec jekyll serve --watch
```
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 10:59:02 +00:00			`---`
			`last_review_date: "1970-01-01"`
			`---`

docs: add webrick gem, generation info 2024-05-13 14:13:07 -04:00			`# Homebrew Docs`

			`These are the source files for the [Homebrew documentation site](https://docs.brew.sh/).`

			`A [GitHub Action](https://github.com/Homebrew/brew/blob/master/.github/workflows/docs.yml) is run to validate each change before the site is deployed to GitHub Pages.`

			`## Usage`

			`Open <https://docs.brew.sh> in your web browser.`

Unlink `localhost:4000` - it doesn't need to be a link 2025-02-03 13:23:16 +00:00			`To instead generate the site locally, available on localhost:4000, run:`
docs: add webrick gem, generation info 2024-05-13 14:13:07 -04:00
			```bash
			cd `brew --repository`/docs
			`bundle install`
			`bundle exec jekyll serve --watch`
			```