diff options
| author | Megan Wachs | 2021-10-14 10:24:24 -0700 |
|---|---|---|
| committer | GitHub | 2021-10-14 17:24:24 +0000 |
| commit | 7931172c0af79e932c6fe373846a7804c820be15 (patch) | |
| tree | f4eb4fe210f42b2f3b1c5cbdceb80a2b8e003343 | |
| parent | 8ed9940ed943d0b7f4248d26c598a95c62340f26 (diff) | |
Update docs README with instructions for new pages (#2171)
* Update docs README with instructions for new pages
* Update docs/README.md
| -rw-r--r-- | docs/README.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md index 2a34fc45..23755bc9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -24,6 +24,14 @@ Our documentation strategy for this repository is as follows: * Tutorials are kept in a separate repository. This documentation is hosted on the Chisel [website](https://www.chisel-lang.org). +Currently, edits to this repo which are backported to the most recent stable branch +(`3.4.x` at time of writing) will be picked up automatically by the +website [repository](https://github.com/freechipsproject/www.chisel-lang.org) and pushed live within +a day or so. +If you create a *new* document page, you probably also want to: + 1. Make sure to add it to the "Contents" page of the corresponding directory [cookbooks](src/cookbooks/cookbooks.md), + [explanations](src/explanations/explanations.md), etc. + 1. Update the sidebar on the website [here](https://github.com/freechipsproject/www.chisel-lang.org/blob/master/docs/src/main/resources/microsite/data/menu.yml). ## mdoc |