Skip to content
Snippets Groups Projects
Unverified Commit c3164b01 authored by Matthew Wang's avatar Matthew Wang
Browse files

prep for v0.4.0.rc3

parent 55aa714b
No related branches found
No related tags found
No related merge requests found
...@@ -15,10 +15,61 @@ The project underwent a major maintenance shift in March 2022. ...@@ -15,10 +15,61 @@ The project underwent a major maintenance shift in March 2022.
{: .note } {: .note }
This website is built from the `HEAD` of the `main` branch of the theme repository. This website is built from the `HEAD` of the `main` branch of the theme repository.
{: .warning }
This website includes docs for some new features that are not available in `v0.4.0.rc2` and `v0.3.3`!
Changes to `main` that are *not* in the latest pre-release: Changes to `main` that are *not* in the latest pre-release:
- N/A
## Pre-release v0.4.0.rc3
Hi there! This is (actually) hopefully the last prerelease before `v0.4.0`; in particular, if we find that this prerelease is stable, we'll re-release it as `v0.4.0`.
In general, this is a more mature pre-release; there are few new features. However, we'll highlight [@pdmosses]'s work in [#992] to better optimize nav generation for large sites (ex 100+ pages). We don't expect this to affect most users; however, **it is technically a breaking change**, and we suggest testing your site before upgrading to this prerelease.
We want your feedback! Please [open an issue](https://github.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://github.com/just-the-docs/just-the-docs/discussions) and let us know!
As soon as we get stable test results from major downstream users, we'll push out a `v0.4.0` ASAP - closing out almost 2 years of backlogged work!
### Trying out pre-release `v0.4.0.rc3`
Simlar to the prior release, `v0.4.0.rc3` is a **release candidate** for the theme (i.e., a pre-release) with release `v0.4.0` coming soon. We want your help in testing the changes! As of now, the gem on RubyGems and the repository are updated to `v0.4.0.rc3`.
To use this RC explicitly as a remote theme:
```yml
remote_theme: just-the-docs/just-the-docs@v0.4.0.rc3
```
To use this RC explicitly as a gem-based theme, pin the version in your `Gemfile` and re-run `bundle install` or `bundle update just-the-docs`:
```Ruby
gem "just-the-docs", "0.4.0.rc3"
```
By default, **users will not be upgraded to `0.4.0.rc3`**. To enforce that explicitly, either:
1. pin your gem version in your `Gemfile`, like so
```Ruby
gem "just-the-docs", "0.3.3"
```
2. freeze the `remote_theme`, like so
```yml
remote_theme: just-the-docs/just-the-docs@v0.3.3
```
### Features
Broadly, this prerelease is feature-light!
- Added: styling for `<blockquote>` by [@mattxwang] in [#965] - Added: styling for `<blockquote>` by [@mattxwang] in [#965]
- Added: custom include for TOC heading by [@pdmosses] in [#980] - Added: custom include for TOC heading by [@pdmosses] in [#980]
### Bugfixes and Experimental Features
*Note*: experimental nav optimization may be unstable. Please give us feedback!
- Added: experimental nav optimization for simple cases by [@pdmosses] in [#992] - Added: experimental nav optimization for simple cases by [@pdmosses] in [#992]
- Fixed: spacing issue when search is disabled by [@henryiii] in [#960] - Fixed: spacing issue when search is disabled by [@henryiii] in [#960]
- Fixed: active grandchild link class by [@pdmosses] in [#962] - Fixed: active grandchild link class by [@pdmosses] in [#962]
...@@ -41,6 +92,8 @@ Changes to `main` that are *not* in the latest pre-release: ...@@ -41,6 +92,8 @@ Changes to `main` that are *not* in the latest pre-release:
[@henryiii]: https://github.com/henryiii [@henryiii]: https://github.com/henryiii
**Full Changelog**: https://github.com/just-the-docs/just-the-docs/compare/v0.4.0.rc2...v0.4.0.rc3
## Pre-release v0.4.0.rc2 ## Pre-release v0.4.0.rc2
{: .warning } {: .warning }
......
...@@ -61,7 +61,6 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/just-t ...@@ -61,7 +61,6 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/just-t
- Open a [Pull Request](https://github.com/just-the-docs/just-the-docs/pulls) - Open a [Pull Request](https://github.com/just-the-docs/just-the-docs/pulls)
- Ensure all CI tests pass - Ensure all CI tests pass
- Await code review - Await code review
- Bump the version number in `just-the-docs.gemspec` and `package.json` according to [semantic versioning](https://semver.org/).
### Design and development principles of this theme: ### Design and development principles of this theme:
......
...@@ -17,18 +17,18 @@ Just the Docs gives your documentation a jumpstart with a responsive Jekyll them ...@@ -17,18 +17,18 @@ Just the Docs gives your documentation a jumpstart with a responsive Jekyll them
--- ---
{: .new } {: .new }
> **Pre-release version `0.4.0.rc2` is available!** > **Pre-release version `0.4.0.rc3` is available!**
> See [the CHANGELOG]({{ site.baseurl }}{% link CHANGELOG.md %}) for a detailed breakdown. > See [the CHANGELOG]({{ site.baseurl }}{% link CHANGELOG.md %}) for a detailed breakdown.
{: .warning } {: .warning }
> Specifying `gem "just-the-docs"` in your `Gemfile` uses the latest ***release*** (`v0.3.3`), ignoring all pre-releases! > Specifying `gem "just-the-docs"` in your `Gemfile` uses the latest ***release*** (`v0.3.3`), ignoring all pre-releases!
> To use this pre-release, pin it: > To use this pre-release, pin it:
> ```ruby > ```ruby
> gem "just-the-docs", "0.4.0.rc2" > gem "just-the-docs", "0.4.0.rc3"
> ``` > ```
> and/or > and/or
> ```yaml > ```yaml
> remote_theme: just-the-docs/just-the-docs@v0.4.0.rc2 > remote_theme: just-the-docs/just-the-docs@v0.4.0.rc3
> ``` > ```
## Getting started ## Getting started
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
Gem::Specification.new do |spec| Gem::Specification.new do |spec|
spec.name = "just-the-docs" spec.name = "just-the-docs"
spec.version = "0.4.0.rc2" spec.version = "0.4.0.rc3"
spec.authors = ["Patrick Marsceill", "Matthew Wang"] spec.authors = ["Patrick Marsceill", "Matthew Wang"]
spec.email = ["patrick.marsceill@gmail.com", "matt@matthewwang.me"] spec.email = ["patrick.marsceill@gmail.com", "matt@matthewwang.me"]
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment