Project file updates for v4.0.0

hollasch · hollasch · commit 11f4d728a8fb · 2024-07-26T12:56:37.000-07:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -13,19 +13,21 @@ improvements.
 Development Branches
 ---------------------
 We use `release` as our release branch. _Generally, changes should never go directly to the release
-branch_. All ongoing development work (and all of the latest changes) will be in the `dev` branch.
-However, we may want changes in other development branches (for example, in a `dev-patch` branch for
-a quick patch release). The appropriate target branch for any pull requests you want to make will be
-determined in the associated issue first (all pull requests should have an associated issue).
+branch_. All ongoing development work (and all of the latest changes) will be in the `dev-patch`,
+`dev-minor`, `dev-major`, or feature branches. The appropriate target branch for any pull requests
+you want to make will be determined in the associated issue first (all pull requests should have an
+associated issue).
 
 
 Issues
 -------
 The easiest way to help out is to log any issues you find in the books. Unclear passages, errors of
 all kinds, even better ways to present something -- just go to the [issues page][].
 
-1. First ensure that the issue is still outstanding in the current development branch (`dev`). Often
-   the issue has already been addressed or no longer applies to the latest in-development version.
+1. First ensure that the issue is still outstanding (check `dev-patch`, `dev-minor` or `dev-major`
+   as appropriate). Often the issue has already been addressed or no longer applies to the latest
+   in-development version. Admittedly, that's a bit of a hassle, but at least step two should help
+   you avoid duplicate issues.
 
 2. **Before creating a new issue**, please review existing issues to see if someone has already
    submitted the same one. Chances are you're not the first to encounter something, so a little
@@ -55,7 +57,7 @@ To contribute a change to the project, *please follow these steps*:
      for the release type and release schedule.
 
   4. Once you've received instructions to proceed with your change, create a new feature branch (or
-     fork) from the assigned development branch (usually `dev`).
+     fork) from the assigned development branch (usually `dev-patch`, `dev-minor`, or `dev-major`).
 
   5. Follow the existing code style.
 
@@ -82,7 +84,7 @@ To contribute a change to the project, *please follow these steps*:
        [issue #1262](https://github.com/RayTracing/raytracing.github.io/issues/1262) and
        [PR #1263](https://github.com/RayTracing/raytracing.github.io/pull/1263).
 
-  7. When ready, create your pull request (PR) and request a review from "rt-reviewers".
+  7. When ready, create your pull request (PR) and request a review from "RayTracing/reviewers".
 
   8. Congratulate yourself for having been part of the 1% of contributors who actually read and
      followed these guidelines.
diff --git a/PRINTING.md b/PRINTING.md
@@ -13,7 +13,7 @@ may be a fix in the works for this.
 
 Pre-Printed Books
 ------------------
-I've gone back and created PDFs for each book for versions v2.0.0, v3.0.0, v3.2.3. You can find
+I've gone back and created PDFs for each book for versions since v2.0.0. You can find
 these in the assets section of each release on the [GitHub releases page][releases]. We will include
 PDFs for all books with all future releases.
 
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@ Getting the Books
 The _Ray Tracing in One Weekend_ series of books are now available to the public for free directly
 from the web.
 
-### Version 4.0.0-alpha.2
+### Version 4.0.0
 
   - [Ray Tracing in One Weekend][web1]
   - [Ray Tracing: The Next Week][web2]
@@ -29,20 +29,12 @@ first**_.
 
 Project Status
 ---------------
-Ok, v4.0.0-alpha.2 is finally out the door, and we are now heads down on getting the final v4.0.0
-version complete and shipped by SIGGRAPH 2024, July 28. At present, that means we are largely
-focused on _Ray Tracing: The Rest of Your Life_ — the third book in the series.
+v4.0.0 has shipped! Three and a half years in the making, with massive changes to all three books
+and accompanying code.
 
-**v4.0.0-alpha.2 is released.** Books one and two are largely complete, and we're now focusing on
-book three. You can find it at the regular spot: https://raytracing.github.io. We are temporarily
-preserving the final version of v3.2.3 inside the repo, so you can just grab the latest and
-reference both versions.
-
-If you'd like to check out the latest updates and watch our progress, we're on the `dev` branch. You
-can also browse our release backlog to see what we're planning. Our relevant milestones are
-
-  - [v4.0.0](https://github.com/RayTracing/raytracing.github.io/milestone/16)
-  - [v4.0.0-release](https://github.com/RayTracing/raytracing.github.io/milestone/19)
+If you'd like to check out the latest updates and watch our progress, we're on the `dev-patch`,
+`dev-minor`, and `dev-major` branches. You can also browse our release backlog to see what we're
+planning.
 
 If you're interested in contributing, email us! You can find our contact info at the head of each
 book. Or just start [a new discussion][discussions] or [issue][issues].
@@ -95,15 +87,15 @@ represent ideal (or optimized) C++ code.
 
 ### Implementations in Other Languages
 The _Ray Tracing in One Weekend_ series has a long history of implementations in other programming
-languages (see [_Implementations in Other Languages_][implementations]), and across different
+languages (see [Implementations in Other Languages][implementations]), and across different
 operating systems. Feel free to add your own implementation to the list!
 
 ### Branches
-In general, ongoing development, with all of the latest changes, can be found in the `dev` branch,
-which may contain patch, minor and major changes, depending on the release in progress. We try to
-keep CHANGELOG.md up to date, so you can easily browse what's new in each development branch. We may
-from time to time use additional development branches, so stay up to date by reviewing the
-[CONTRIBUTING][] page.
+In general, ongoing development, with all of the latest changes, can be found in the `dev-patch`,
+`dev-minor`, and `dev-major` branches, minor and major changes, depending on the change level and
+release in progress. We try to keep CHANGELOG.md up to date, so you can easily browse what's new in
+each development branch. We may from time to time use additional development branches, so stay up to
+date by reviewing the [CONTRIBUTING][] page.
 
 The `release` branch contains the latest released (and live) assets. This is the branch from which
 GitHub pages serves up https://raytracing.github.io/.
@@ -211,10 +203,7 @@ _**please review the [CONTRIBUTING][] document for the most effective way to pro
 [ImageMagick]:     https://imagemagick.org/
 [implementations]: https://github.com/RayTracing/raytracing.github.io/wiki/Implementations
 [issues]:          https://github.com/RayTracing/raytracing.github.io/issues/
-[milestone 16]:    https://github.com/RayTracing/raytracing.github.io/milestone/16
-[milestone 19]:    https://github.com/RayTracing/raytracing.github.io/milestone/19
 [PRINTING.md]:     PRINTING.md
-[v3.2.3]:          https://github.com/RayTracing/raytracing.github.io/releases/tag/v3.2.3
 [web1]:            https://raytracing.github.io/books/RayTracingInOneWeekend.html
 [web2]:            https://raytracing.github.io/books/RayTracingTheNextWeek.html
 [web3]:            https://raytracing.github.io/books/RayTracingTheRestOfYourLife.html
diff --git a/index.html b/index.html
@@ -24,20 +24,10 @@ <h1 class="title">Ray Tracing in One Weekend<br>—<br>The Book Series</h1>
   </div>
 
 
-  <h1 class='alert' id='alpha'>Version 4.0.0-alpha.2</h1>
-
-  <p>The v4.0.0-alpha.2 release is the second and planned last alpha release of the book series. While the primary focus
-  of this release has been updates to <cite>Ray Tracing: The Next Week</cite>, the alpha releases have significant
-  updates across all three books. We recommend that readers use this version over the old v3.2.3 version. For a summary
-  of changes, see <a href="https://github.com/RayTracing/raytracing.github.io/blob/master/CHANGELOG.md">the
-  CHANGELOG</a>. We are currently planning to release the final v4.0.0 version by SIGGRAPH 2024, July 28. Please log all
-  issues and suggestions <a href="https://github.com/RayTracing/raytracing.github.io/issues">on the GitHub issues
-  page</a> for our project.
-
   <h1 id='books'>Getting the Books</h1>
 
   <p>The <cite>Ray Tracing in One Weekend</cite> series of books are now available to the public for free online. They
-  are now released under <a href="https://github.com/RayTracing/raytracing.github.io/blob/master/COPYING.txt">the CC0
+  are now released under <a href="https://github.com/RayTracing/raytracing.github.io/blob/release/COPYING.txt">the CC0
   license</a>. This means that they are as close to public domain as we can get. (While that also frees you from the
   requirement of providing attribution, it would help the overall project if you could point back to this web site as a
   service to other users.)
@@ -73,8 +63,8 @@ <h1 id='source'>Source Code</h1>
   <a href="https://github.com/RayTracing/raytracing.github.io">https://github.com/RayTracing/raytracing.github.io</a>.
   You can also directly download the latest version of the entire project (all three books) as a single archive file:
   <ul>
-    <li><a href="https://github.com/RayTracing/raytracing.github.io/archive/master.zip">.ZIP format</a>
-    <li><a href="https://github.com/RayTracing/raytracing.github.io/archive/master.tar.gz">.tar.gz format</a>
+    <li><a href="https://github.com/RayTracing/raytracing.github.io/archive/release.zip">.ZIP format</a>
+    <li><a href="https://github.com/RayTracing/raytracing.github.io/archive/release.tar.gz">.tar.gz format</a>
   </ul>
 
 
@@ -90,7 +80,7 @@ <h1 id='issues'>Issues</h1>
 
   <h1 id='contributing'>Contributing</h1>
   <p>Interested in helping out? Please read the guidelines in the
-  <a href="https://github.com/RayTracing/raytracing.github.io/blob/master/CONTRIBUTING.md">CONTRIBUTING.md</a> document
+  <a href="https://github.com/RayTracing/raytracing.github.io/blob/release/CONTRIBUTING.md">CONTRIBUTING.md</a> document
   first. <em>Pull requests without associated issues, or submitted without coordination, are highly likely to be
   rejected.</em>
 
