Skip to content

Commit d845903

Browse files
committed
Update docs
1 parent a076230 commit d845903

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This site is built with Eleventy and Tailwind.
44

5-
PRs should be made against the `build` branch. Upon merging, a maintainer will separately run the deploy scripts which commits a build version of the site to the `master` branch.
5+
PRs should be made against the `build` branch. Upon merging, a GitHub Action will build and deploy the site to the `master` branch.
66

77
## Prerequisites
88

@@ -14,13 +14,13 @@ Run `npm run start` and access the dev server at the address it reports.
1414

1515
## Build
1616

17-
Run `npm build`, and a built version will be written to `/dist`. This will
18-
also update the markdown files that define our code of conduct, speaker
19-
questionnaire, and sponsorship levels from the [admin repository](https://github.com/javascriptmn/javascriptmn)
17+
Run `npm build`, and a built version will be written to `/dist`. You can run the built site in a web server, for example, `npx serve dist`.
18+
19+
Building for production minifies HTML, CSS, and JavaScript files as well as adds a cachebusting parameter to those resources.
2020

2121
## Style
2222

23-
This repository is configured to use [prettier](https://prettier.io/) on commit.
23+
We've configured [prettier](https://prettier.io/) to run before a commit, however it doesn't support Nunjucks templates, so it's not quite as valuable as we'd like.
2424

25-
It will lint and format your changes automatically, so don't worry about following
25+
Prettier will lint and format your changes automatically, so don't worry about following
2626
format standards (so long as your code passes the lint-staged step).

0 commit comments

Comments
 (0)