Update CHANGELOG

uttori · Dec 23, 2023 · c6e2f15 · c6e2f15
1 parent 60ea61a
commit c6e2f15
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,8 +4,30 @@ All notable changes to this project will be documented in this file. This projec
 
 ## [6.0.0](https://github.com/uttori/uttori-wiki/compare/v5.2.2...v6.0.0) - 2023-12-22
 
-- 🧰 Add support for setting the paths for `tags` and `search`, as well as their titles.
-- 🧰 Remove support for CommonJS, now requires ESM support.
+- 💥 BREAKING CHANGES!
+- 💥 Rename config key: `home_page` to `homePage`
+- 💥 Rename config key: `ignore_slugs` to `ignoreSlugs`
+- 💥 Rename config key: `home_page` to `excerptLength`
+- 💥 Rename config key: `excerpt_length` to `homePage`
+- 💥 Rename config key: `site_url` to `publicUrl`
+- 💥 Rename config key: `theme_dir` to `themePath`
+- 💥 Rename config key: `public_dir` to `publicPath`
+- 💥 Rename config key: `use_delete_key` to `useDeleteKey`
+- 💥 Rename config key: `delete_key` to `deleteKey`
+- 💥 Rename config key: `use_edit_key` to `useEditKey`
+- 💥 Rename config key: `edit_key` to `editKey`
+- 💥 Rename config key: `public_history` to `publicHistory`
+- 💥 Rename config key: `handle_not_found` to `handleNotFound`
+- 💥 Rename config key: `use_cache` to `useCache`
+- 💥 Rename config key: `cache_short` to `cacheShort`
+- 💥 Rename config key: `cache_long` to `cacheLong`
+- 💥 Removed many configuration options that were not being used or items that should be theme specific: `site_title`, `site_header`, `site_footer`, `site_sections`, `site_locale`, `site_twitter_site`, `site_twitter_creator`, `site_image`
+- 🧰 Add support for setting the `routes` for search & tags
+- 🧰 Add support for setting the `titles` for search & tags
+- 🧰 Added support for `allowCRUDRoutes` to disable the CRUD routes for a read-only wiki
+- 🧰 Added support for `ignoreTags` to ignore documents with specific tags
+- 🧰 Remove support for CommonJS, now requires ESM support
+- Change the `detailRoute` route path matcher to `/:slug*?` to allow for nested routes with the use of overriding `detailRoute` and handling the `request.params.slug` value accordingly`
 - 🎁 Update dependencies
 - 🛠 Standardize types
 - 🛠 Update ESLint configuration

diff --git a/README.md b/README.md
@@ -235,8 +235,7 @@ const config = {
           fallback: [],
         },
         {
-          query: 'query',
-          key: 'key',
+          key: 'popularDocuments',
           fallback: [],
           format: (results) => results.map((result) => result.slug),
           queryFunction: async (target, context) => {

diff --git a/rm.hbs b/rm.hbs
@@ -235,8 +235,7 @@ const config = {
           fallback: [],
         },
         {
-          query: 'query',
-          key: 'key',
+          key: 'popularDocuments',
           fallback: [],
           format: (results) => results.map((result) => result.slug),
           queryFunction: async (target, context) => {