Skip to content

Commit d4f7d95

Browse files
committed
Update RELEASE_NOTES.md
1 parent f6a4725 commit d4f7d95

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

RELEASE_NOTES.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ This serves two purposes:
1919
- **Breaking:** The internals of the navigation system has been rewritten into a new Navigation API. This change is breaking for custom navigation implementations. For more information, see below.
2020
- **Breaking:** The `hyde.features` configuration format has changed to use Enums instead of static method calls. For more information, see below.
2121
- **Breaking:** Renamed class `DataCollections` to `DataCollection`. For more information, see below.
22+
- **Breaking:** The `hyde.authors` config setting should now be keyed by the usernames. For more information, see below.
2223
- Medium: The `route` function will now throw a `RouteNotFoundException` if the route does not exist in https://github.com/hydephp/develop/pull/1741
2324
- Minor: Navigation menu items are now no longer filtered by duplicates (meaning two items with the same label can now exist in the same menu) in https://github.com/hydephp/develop/pull/1573
2425
- Minor: Due to changes in the navigation system, it is possible that existing configuration files will need to be adjusted in order for menus to look the same (in terms of ordering etc.)
@@ -29,6 +30,7 @@ This serves two purposes:
2930
- Minor: `Includes::path()` and `Includes::get()` methods now normalizes paths to be basenames to match the behaviour of the other include methods in https://github.com/hydephp/develop/pull/1738. This means that nested directories are no longer supported, as you should use a data collection for that.
3031
- Minor: The `processing_time_ms` attribute in the `sitemap.xml` file has now been removed in https://github.com/hydephp/develop/pull/1744
3132
- Minor: Updated the `Hyde::url()` helper to return `null` instead of throwing a `BaseUrlNotSetException` when no site URL is set and no path was provided to the method in https://github.com/hydephp/develop/pull/1760
33+
- Overhauled the blog post author feature in https://github.com/hydephp/develop/pull/1782
3234
- Improved the sitemap data generation to be smarter and more dynamic in https://github.com/hydephp/develop/pull/1744
3335
- Skipped build tasks will now exit with an exit code of 3 instead of 0 in https://github.com/hydephp/develop/pull/1749
3436
- The `hasFeature` method on the Hyde facade and HydeKernel now only accepts a Feature enum value instead of a string for its parameter.
@@ -47,6 +49,7 @@ This serves two purposes:
4749
- Breaking: Removed the deprecated `\Hyde\Framework\Services\BuildService::transferMediaAssets()` method (see upgrade guide below)
4850
- Removed the deprecated global`unslash()` function, replaced with the namespaced `\Hyde\unslash()` function in https://github.com/hydephp/develop/pull/1754
4951
- Removed the deprecated `BaseUrlNotSetException` class, with the `Hyde::url()` helper now returning `null` if no base URL is set in https://github.com/hydephp/develop/pull/1760
52+
- Removed: The deprecated `PostAuthor::getName()` method is now removed (use `$author->name`) in https://github.com/hydephp/develop/pull/1782
5053
- Internal: Removed the internal `DocumentationSearchPage::generate()` method as it was unused in https://github.com/hydephp/develop/pull/1569
5154

5255
### Fixed
@@ -146,6 +149,23 @@ Of course, if you have disabled any of the features, do not include them in the
146149

147150
## General impact
148151

152+
### Post Author changes
153+
154+
This release makes major improvements into the usability and design of the blog post author feature.
155+
156+
Here is the full list of changes:
157+
158+
- Breaking: The `hyde.authors` config setting should now be keyed by the usernames
159+
- Removed: The deprecated `PostAuthor::getName()` method is now removed (use `$author->name`)
160+
- Feature: We now support setting authors in the YAML configuration! Fixes `#1719`
161+
- Feature: Added a `$author->getPosts()` method to get all author's posts
162+
- Feature: Authors now can also have custom biographies and social media links
163+
- The PostAuthor class is now Arrayable and JsonSerializable
164+
- The collection of site authors are now stored in the HydeKernel
165+
- Authors can additionally be accessed through `Hyde::authors()`
166+
167+
For more information, see https://github.com/hydephp/develop/pull/1782
168+
149169
### Documentation search page changes
150170

151171
The documentation search page and search index have been changed to be generated as `InMemoryPages` instead of a post-build task.

0 commit comments

Comments
 (0)