Skip to content

Commit a50003a

Browse files
committed
Update website and contributors guide.
1 parent 6f75477 commit a50003a

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@
3434

3535
- In the introduction section(s), provide at least a few sentences of high-level description of the feature, to orient the user. Include external links and internal links. Then, include some short code snippets showing a minimal example of the feature being used. If relevant, include some simple Tex math.
3636

37-
- Build the docs locally to test that it builds and looks right:
38-
```sh
39-
./docs/build_docs_locally.sh
40-
```
37+
- Build the docs locally to test that it builds and looks right.
38+
39+
- Once you have a made a PR and are assigned a PR `NUMBER`, update your PR description with a link to the automatically generated documentation preview at https://www.gen.dev/docs/previews/PR{NUMBER}.

WEBSITE.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
1-
The Gen website is hosted on Github pages at https://probcomp.github.io/Gen/
1+
The Gen website is hosted at https://www.gen.dev/.
22

33
The website is generated from the source files that are at the head commit of the `gh-pages` branch of the Gen repository.
44

55
To edit the website, check out the `gh-pages` branch, and commit and push changes.
66

7-
Automatically-generated Gen documentation is pushed to the `gh-pages` branch whenever a commit is made to the `master` branch of the Gen repository using a combination of Github Actions and Documenter.jl, which are configured in the files `.github/workflows/Documentation.yml` and `docs/make.jl` in the `master` branch.
7+
Automatically-generated Gen documentation is pushed to the `docs` folder of the `gh-pages` branch whenever a commit is made to the `master` branch of the Gen repository using a combination of Github Actions and Documenter.jl, which are configured in the files `.github/workflows/Documentation.yml` and `docs/make.jl` in the `master` branch. When a pull request is merged into the `master` branch, the `gh-pages` branch is updated with the new documentation, and documentation previews will be cleaned up by the `.github/workflows/Documentation.yml` workflow.
8+
89
The automatically-managed files and directories are:
910

10-
- `dev/` (documentation for the version of Gen on the head of `master` branch)
11+
- `docs/dev/` (documentation for the version of Gen on the head of `master` branch)
12+
13+
- `docs/v*.*.*/` (directories that contain documentation for each tagged release of Gen)
1114

12-
- `v*.*.*/` (directories that contain documentation for each tagged release of Gen)
15+
- `docs/latest/` (a symbolic link to `dev/`)
1316

14-
- `latest/` (a symbolic link to `dev/`)
17+
- `docs/stable/` (a symbolic link to the documentation directory of the latest tagged release Gen)
1518

16-
- `stable/` (a symbolic link to the documentation directory of the latest tagged release Gen)
19+
- `docs/previews/` (documentation previews for unmerged pull requests)
1720

18-
- `versions.js`
21+
- `docs/versions.js`
1922

2023
*Do not make commits that modify the contents of these automatically managed files and directories.*
2124

0 commit comments

Comments
 (0)