Skip to content

Commit 4a73d0e

Browse files
committed
doc: update DEVELOPMENT.md
1 parent cfb6578 commit 4a73d0e

File tree

1 file changed

+7
-15
lines changed

1 file changed

+7
-15
lines changed

DEVELOPMENT.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,10 @@ devtools::check() # check package for errors
1919

2020
## Developing the documentation site
2121

22-
Our CI is setup to build the [main documentation site](https://cmu-delphi.github.io/epidatr/) off of the `main` branch, while the [`dev` version of the site](https://cmu-delphi.github.io/epidatr/dev) is built off the `dev` branch.
22+
Our CI builds two version of the documentation:
23+
24+
- https://cmu-delphi.github.io/epidatr/ from the `main` branch and
25+
- https://cmu-delphi.github.io/epidatr/dev from the `dev` branch.
2326

2427
The documentation site can be previewed locally by running in R:
2528

@@ -28,7 +31,8 @@ The documentation site can be previewed locally by running in R:
2831
pkgdown::build_site(preview=TRUE)
2932
```
3033

31-
If the above does not open a browser, you can try using a Python server from the command line:
34+
If the above does not open a browser, you can try using a Python server from the
35+
command line:
3236

3337
```bash
3438
R -e 'devtools::document()'
@@ -38,19 +42,7 @@ python -m http.server -d docs
3842

3943
## Versioning
4044

41-
Please follow the guidelines in the PR template document (reproduced here):
42-
43-
- [ ] Make sure this PR is against "dev", not "main".
44-
- [ ] Request a review from one of the current epiprocess main reviewers:
45-
brookslogan, nmdefries.
46-
- [ ] Makes sure to bump the version number in `DESCRIPTION` and `NEWS.md`.
47-
Always increment the patch version number (the third number), unless you are
48-
making a release PR from dev to main, in which case increment the minor
49-
version number (the second number).
50-
- [ ] Describe changes made in NEWS.md, making sure breaking changes
51-
(backwards-incompatible changes to the documented interface) are noted.
52-
Collect the changes under the next release number (e.g. if you are on
53-
0.7.2, then write your changes under the 0.8 heading).
45+
Please follow the guidelines in the [PR template document](.github/pull_request_template.md).
5446

5547
## Release process
5648

0 commit comments

Comments
 (0)