v23.05: proof-read post, added update page notes

diff --git a/content/blog/bookstack-release-v23-05.md b/content/blog/bookstack-release-v23-05.md
index e1768d37acfbfde427fb27f6df0897e86128af5e..68890aea9ea36e4123e1742e978eb512cdbddf5f 100644 (file)
--- a/content/blog/bookstack-release-v23-05.md
+++ b/content/blog/bookstack-release-v23-05.md
@@ -13,17 +13,14 @@ BookStack v23.05 releases today, sneaking into the start of May with a
 bunch of additions, updates and changes including a new command line tool
 to help with admin operations. 
 
 bunch of additions, updates and changes including a new command line tool
 to help with admin operations. 
 

-* [Update instructions](https://www.bookstackapp.com/docs/admin/updates)
+* [Update instructions](/docs/admin/updates)

 * [GitHub release page](https://github.com/BookStackApp/BookStack/releases/tag/v23.05)
 
 **Upgrade Notices**
 
 * [GitHub release page](https://github.com/BookStackApp/BookStack/releases/tag/v23.05)
 
 **Upgrade Notices**
 

-TODO - Add to updates page
-TODO - Check docs changes
-

 - **Page Include Tags** - Nesting is now allowed for [include tags](https://www.bookstackapp.com/docs/user/reusing-page-content/#include-tags), up to 3 levels of depth. You may now see more content loaded for pages which previously had unparsed nested include tags.
 - **Page Include Tags** - Nesting is now allowed for [include tags](https://www.bookstackapp.com/docs/user/reusing-page-content/#include-tags), up to 3 levels of depth. You may now see more content loaded for pages which previously had unparsed nested include tags.

-- **SAML2** - SAML2 Single LogOut (SLO) requests will now include a "session_index" for the current user. This technically brings BookStack's implementation closer to the spec, and is not expected to cause issues, but if using SLO it may be wise to check your identity provider behavior remains the same as before during logout.
-- **Custom Code Block Themes** - Due to a change of library, the way custom code block themes has significantly changed, as no longer uses the "window.CodeTheme" method previously used. Refer to our ["Changing Code Block Themes"](https://www.bookstackapp.com/docs/admin/visual-customisation/#changing-code-block-themes) documentation for further information.
+- **SAML2** - Single LogOut (SLO) requests will now include a "session_index" for the current user. This technically brings BookStack's implementation closer to the spec, and is not expected to cause issues, but if using SLO it may be wise to check your identity provider behavior remains the same as before during logout.
+- **Custom Code Block Themes** - Due to a change of library, the method of defining custom codeblock themes has significantly changed, and "window.CodeTheme" code is no longer used. Refer to our ["Changing Code Block Themes"](https://www.bookstackapp.com/docs/admin/visual-customisation/#changing-code-block-themes) documentation for further information.

 - **Editor Event - editor-markdown::setup** - This event no longer contains "codeMirrorInstance" in the event data. It instead has a "cmEditorView" property. [See the event docs for more details](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/javascript-public-events.md#editor-markdownsetup).
 - **Editor Event - editor-markdown-cm::pre-init** - This event has been renamed to "editor-markdown-cm6::pre-init" and no longer contains "config" in the event data. It instead has a "editorViewConfig" property. [See the event docs for more details](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/javascript-public-events.md#editor-markdown-cm6pre-init).
 - **Upload Timeouts** - The use of "window.uploadTimeout" has been removed as a way to control upload timeouts. This would previously only be used in certain cases. Instead, if required, timeouts can usually be enforced at the web-server level.
 - **Editor Event - editor-markdown::setup** - This event no longer contains "codeMirrorInstance" in the event data. It instead has a "cmEditorView" property. [See the event docs for more details](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/javascript-public-events.md#editor-markdownsetup).
 - **Editor Event - editor-markdown-cm::pre-init** - This event has been renamed to "editor-markdown-cm6::pre-init" and no longer contains "config" in the event data. It instead has a "editorViewConfig" property. [See the event docs for more details](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/javascript-public-events.md#editor-markdown-cm6pre-init).
 - **Upload Timeouts** - The use of "window.uploadTimeout" has been removed as a way to control upload timeouts. This would previously only be used in certain cases. Instead, if required, timeouts can usually be enforced at the web-server level.


@@ -32,9 +29,9 @@ TODO - Video Link
 
 ### New System CLI (Early Alpha)
 
 
 ### New System CLI (Early Alpha)
 

-When it comes to managing a BookStack instance, backup and restore has always been a point of contention.
+When it comes to managing a BookStack instance, backup & restore has always been a point of contention.

 Ultimately, the method of backup can depend on preference, hosting and environment.
 Ultimately, the method of backup can depend on preference, hosting and environment.

-Our documentation provided a generic set of commands & actions to achieve backup & restore, but while some found these simple and scriptable, 
+Our documentation provides a generic set of commands & actions to achieve backup & restore, but while some found these simple and scriptable, 

 some found the process overwhelming and complicated.
 
 To help with backup, restore, and other tasks, with this release I'm introducing the BookStack System CLI.
 some found the process overwhelming and complicated.
 
 To help with backup, restore, and other tasks, with this release I'm introducing the BookStack System CLI.


@@ -45,27 +42,27 @@ This is a new CLI tool, included within the BookStack app files, that can perfor
 - **Restore** - Restore a backup ZIP into an instance of BookStack.
 - **Update** - Update an existing BookStack installation to the latest version.
 
 - **Restore** - Restore a backup ZIP into an instance of BookStack.
 - **Update** - Update an existing BookStack installation to the latest version.
 

-This CLI is technically managed as [a new separate project](https://github.com/BookStackApp/system-cli) and is actually self-contained
-and independent of the BookStack codebase, meaning it can be downloaded and be used alone without an existing working BookStack install.
+This CLI is technically managed as [a new separate project](https://github.com/BookStackApp/system-cli) and is self-contained,
+ independent of the BookStack codebase, meaning it can be downloaded and used without an existing working BookStack install.

 
 Here's a demo of using the CLI to take a backup, and restoring that backup into a new instance created by the CLI:
 
 [![asciicast](https://asciinema.org/a/whALf4oAkhBU3VeuOAjpmGEGz.svg)](https://asciinema.org/a/whALf4oAkhBU3VeuOAjpmGEGz)
 
 
 Here's a demo of using the CLI to take a backup, and restoring that backup into a new instance created by the CLI:
 
 [![asciicast](https://asciinema.org/a/whALf4oAkhBU3VeuOAjpmGEGz.svg)](https://asciinema.org/a/whALf4oAkhBU3VeuOAjpmGEGz)
 

-To support backups, a new `<bookstack_install_dir>/storage/backups` folder has been added to act as the default backup output location, but alternatively the output zip can be provided when running the command if a custom path is preferred.
+To support backups, a new `<bookstack_install_dir>/storage/backups` folder has been added to act as the default backup output location, but alternatively a path for the output zip can be provided when running the command if a custom file name/location is preferred.

 
 It should be noted this new CLI **should be considered an early alpha** implementation, with the likelihood to run into bugs relatively high.
 Some known issues (mostly due to MySQL variance) are [documented in the project readme](https://github.com/BookStackApp/system-cli#known-issues).
 The CLI is written in PHP, and made to be platform abstract. So far i've been testing this across a range of unix-based systems but this kind of CLI is still very environment dependant so it may be a while before things mature.
 
 It should be noted this new CLI **should be considered an early alpha** implementation, with the likelihood to run into bugs relatively high.
 Some known issues (mostly due to MySQL variance) are [documented in the project readme](https://github.com/BookStackApp/system-cli#known-issues).
 The CLI is written in PHP, and made to be platform abstract. So far i've been testing this across a range of unix-based systems but this kind of CLI is still very environment dependant so it may be a while before things mature.

-Behaviour, Output, options and the CLI name may change over time as I gain feedback from people using this.
+Behaviour, output, options and the CLI name may change over time as I gain feedback from people using this.

 
 

-In the longer-term vision, I may integrate this CLI with the BookStack interface, so that things like backups can be managed from in-app, but that brings its own complications and I'd like to see the CLI mature first.
+In the longer-term vision, I may integrate this CLI with the BookStack interface, so that things like backups can be managed from within the application, but that brings its own complications and I'd like to see the CLI mature first.

 
 

-### New File Upload Handling & Attachment Manager Simplification
+### New Upload Handling & Attachment Manager Simplification

 
 File upload handling has been revamped in a few key areas, specifically the image manager and attachment manager UIs, found when editing a page.
 
 File upload handling has been revamped in a few key areas, specifically the image manager and attachment manager UIs, found when editing a page.

-The new experience switches out our previous usage of the [dropzone.js](https://www.dropzone.dev/) library with a much more lightweight 
-custom implementation to provide a more "BookStack" integrated feel, which we'll be able to better utilize in the future:
+The new experience switches out our previous usage of the [dropzone.js](https://www.dropzone.dev/) library with a lightweight 
+custom implementation, with an aim to give us more control while providing a more "BookStack" integrated feel:

 
 ![A screenshot of the BookStack image manager, showing a failed upload containing an error message in red text](/images/2023/05/image-upload-error.png)
 
 
 ![A screenshot of the BookStack image manager, showing a failed upload containing an error message in red text](/images/2023/05/image-upload-error.png)
 


@@ -73,6 +70,7 @@ This new format for image uploads has the added benefit of now showing errors in
 
 To support these changes the areas in which they are used have received some attention.
 The styles of the image manager have been tidied and tightened to provide a cleaner user experience.
 
 To support these changes the areas in which they are used have received some attention.
 The styles of the image manager have been tidied and tightened to provide a cleaner user experience.

+

 The attachment management panel has had a more extensive overhaul, replacing the previous tabbed-based interface
 with a simpler layout that requires less clicks for common upload actions.
 
 The attachment management panel has had a more extensive overhaul, replacing the previous tabbed-based interface
 with a simpler layout that requires less clicks for common upload actions.
 


@@ -81,19 +79,19 @@ with a simpler layout that requires less clicks for common upload actions.
 ### Code Block Updating to CodeMirror 6
 
 Within BookStack all code syntax highlighting and code editing, including that of the Markdown page editor, is assisted by the popular [CodeMirror](https://codemirror.net/) JavaScript library. 
 ### Code Block Updating to CodeMirror 6
 
 Within BookStack all code syntax highlighting and code editing, including that of the Markdown page editor, is assisted by the popular [CodeMirror](https://codemirror.net/) JavaScript library. 

-After being released last year, I started work to upgrade from CodeMirror 5 to 6 in August of last year, but quickly found this update was essentially a rebuild of the library requiring a lot of work on the BookStack side of things.
+After being released last year, I started work to upgrade from CodeMirror 5 to 6 in August 2022, but quickly found this update was essentially a rebuild of the library requiring a lot of work on the BookStack side of things.

 This release cycle I put my head down and spent a lot of time on this so that, as of BookStack v23.05, all such code blocks are now using CodeMirror 6.
 
 ![A simple code block within page content, display code syntax highlighting](/images/2023/05/codemirror-6-block.png)
 
 This release cycle I put my head down and spent a lot of time on this so that, as of BookStack v23.05, all such code blocks are now using CodeMirror 6.
 
 ![A simple code block within page content, display code syntax highlighting](/images/2023/05/codemirror-6-block.png)
 

-This will hopefully not impact most users, while it should bring us better mobile support while keeping us up-to-date on our libraries.
+This will hopefully not impact most users, apart from providing better mobile support while keeping us up-to-date on our libraries.

 This does have some significant impacts to those that had applied customizations, since it changes some of the "Editor Events" we previously had,
 while also significantly changing (and unfortunately complicating) the way custom code themes are applied. 
 See the upgrade notices at the top of the blogpost for more details.
 
 ### API Updates - Image Gallery & Content Permissions
 
 This does have some significant impacts to those that had applied customizations, since it changes some of the "Editor Events" we previously had,
 while also significantly changing (and unfortunately complicating) the way custom code themes are applied. 
 See the upgrade notices at the top of the blogpost for more details.
 
 ### API Updates - Image Gallery & Content Permissions
 

-This release brings two new sets of endpoints to the API, helping to fill gaps and empower our API users to achieve all actions possible via the UI.
+This release brings two new sets of endpoints to the API, helping to fill gaps and further empower our API users to achieve the actions possible via the UI.

 
 ![List of the image gallery and content permission API endpoints](/images/2023/05/image-permissions-api-endpoints.png)
 
 
 ![List of the image gallery and content permission API endpoints](/images/2023/05/image-permissions-api-endpoints.png)
 


@@ -108,21 +106,22 @@ From very early on BookStack has had the ability to dynamically include the whol
 using [page include tags](https://www.bookstackapp.com/docs/user/reusing-page-content/#include-tags).
 These have only ever worked at a single layer though, so "nested" tags within the included content would not then be subsequently parsed.
 
 using [page include tags](https://www.bookstackapp.com/docs/user/reusing-page-content/#include-tags).
 These have only ever worked at a single layer though, so "nested" tags within the included content would not then be subsequently parsed.
 

-Within this release, this behaviour has been changed so that nested include tags will be parsed.
-This works up to three levels of content, with the limit being there to prevent performance and recursion issues.
+Within this release, this behaviour has changed so that nested include tags will now be parsed.
+This works for up to three levels inclusions, with the limit being there to prevent performance and recursion issues.

 
 Thanks to [@jasonF1000](https://github.com/BookStackApp/BookStack/pull/4192) for helping to contribute this feature.
 
 ### Clojure Code Syntax Highlighting
 
 Another new coding language gets highlighting support in this release, with
 
 Thanks to [@jasonF1000](https://github.com/BookStackApp/BookStack/pull/4192) for helping to contribute this feature.
 
 ### Clojure Code Syntax Highlighting
 
 Another new coding language gets highlighting support in this release, with

-the lucky language being clojure:
+the lucky language being Clojure:

 
 ![BookStack WYSIWYG code editor showing Clojure syntax highlighting](/images/2023/05/clojure-code-syntax.png)
 
 ### OIDC ID Token Logical Theme Event
 
 
 ![BookStack WYSIWYG code editor showing Clojure syntax highlighting](/images/2023/05/clojure-code-syntax.png)
 
 ### OIDC ID Token Logical Theme Event
 

-A new `OIDC_ID_TOKEN_PRE_VALIDATE` event has been added to the [logical theme system](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/logical-theme-system.md). This allows the customization of incoming OIDC ID token data which can be useful to perform any changes required
+A new `OIDC_ID_TOKEN_PRE_VALIDATE` event has been added to the [logical theme system](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/logical-theme-system.md). This allows the customization of incoming OIDC ID token data,
+which can be useful to perform any changes required

 that are outside the scope of what the standard and/or BookStack supports.
 
 As an arbitrary example, the below would prefix "Sir" to the names of those that have a name ending in "Chuckle":
 that are outside the scope of what the standard and/or BookStack supports.
 
 As an arbitrary example, the below would prefix "Sir" to the names of those that have a name ending in "Chuckle":


@@ -144,22 +143,22 @@ With all the JavaScript focused work performed for this release, there's been so
 clean-up and alignment performed to keep things tidied and maintained.
 
 First of all, I've added [ESLint](https://eslint.org/) to standardise the formatting and code style
 clean-up and alignment performed to keep things tidied and maintained.
 
 First of all, I've added [ESLint](https://eslint.org/) to standardise the formatting and code style

-across the whole BookStack JavaScript codebase which helps ensure consistency while potentially
-spotting or preventing issues.
+across the whole BookStack JavaScript codebase to help ensure consistency while potentially
+catching or preventing issues.

 
 

-Secondly, the custom public JavaScript events (Which we previously called "Editor Events") have been 
+Secondly, all of our custom public JavaScript events (Which we previously called "Editor Events") have been 

 properly documented within a [developer doc markdown file within the repo](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/javascript-public-events.md), providing details of each event along with an example.
 In addition to providing detail for developers, this helps us track the public API we're providing so it's easier
 properly documented within a [developer doc markdown file within the repo](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/javascript-public-events.md), providing details of each event along with an example.
 In addition to providing detail for developers, this helps us track the public API we're providing so it's easier

-for us to track and advise of breaking changes.
+for us to advise of breaking changes.

 
 

-### Disable SMTP SSL Verification Option
+### Option to Disable SMTP SSL Verification

 
 Many using BookStack in private/local networks would configure the system to send mail via a SMTP
 
 Many using BookStack in private/local networks would configure the system to send mail via a SMTP

-server that used a self/privately-signed certificate, and this could cause BookStack to throw an error
+server that uses a self/privately-signed certificate, and this could cause BookStack to throw an error

 since the certificate was not signed by a commonly known authority.
 
 since the certificate was not signed by a commonly known authority.
 

-While it's often possible to work around this, by adding the custom certificate authority to the system's 
-trusted store, this could be a tricky process in some environments. 
+While it's often possible to work around this, by adding the custom certificate authority to the host system
+trusted certificate store, this could be a tricky process in some environments. 

 As an alternative, the below option can now added to your `.env`:
 
 ```bash
 As an alternative, the below option can now added to your `.env`:
 
 ```bash


@@ -173,32 +172,61 @@ Thanks to [@vincentbernat](https://github.com/BookStackApp/BookStack/pull/4126)
 
 ### Translations
 
 
 ### Translations
 

-Another release means another update the translation content within BookStack from the following
+Another release means another update to translation content within BookStack from the following

 remarkable roster of folks that have provided translation text since the original v23.02 release:
 
 remarkable roster of folks that have provided translation text since the original v23.02 release:
 

-- Name - *Lang*
+- Michal Gurcik (mgurcik) - *Slovak*
+- Jøran Haugli (haugli92) - *Norwegian Bokmal*
+- Ji-Hyeon Gim (PotatoGim) - *Korean*
+- Martins Pilsetnieks (pilsetnieks) - *Latvian*
+- Vitaliy (gviabcua) - *Ukrainian*
+- Vasileios Kouvelis (VasilisKouvelis) - *Greek*
+- jozefrebjak - *Slovak*
+- HeartCore - *German Informal; German*
+- Pooyan Arab (pooyanarab) - *Persian*
+- Dremski - *Bulgarian*
+- SmokingCrop - *Dutch*
+- Ochi Darma Putra (troke12) - *Indonesian*
+- Frédéric SENE (nothingfr) - *French*
+- sdhadi - *Persian*
+- m0uch0 - *Spanish*
+- Indrek Haav (IndrekHaav) - *Estonian*
+- 10935336 - *Chinese Simplified*
+- Maciej Lebiest (Szwendacz) - *Polish*
+- pedromcsousa - *Portuguese*
+- Martin Sebek (sebekmartin) - *Czech*
+- Xabi (xabikip) - *Basque*
+- scureza - *Italian*
+- toras9000 - *Japanese*
+- H.-H. Peng (Hsins) - *Chinese Traditional*
+- Mosi  Wang (mosiwang) - *Chinese Traditional*
+- bendem - *French*
+- 骆言 (LawssssCat) - *Chinese Simplified*
+- kostasdizas - *Greek*
+- Ricardo Schroeder (brownstone666) - *Portuguese, Brazilian*
+- Eitan MG (EitanMG) - *Hebrew*

 
 
 ### Next Steps
 
 
 
 ### Next Steps
 

-Within this release cycle I though a lot more about multi-language support within BookStack, 
-but ran into significant doubts about it about it being worthwhile to make significant content changes to support this
-due to the complexity it'd add, especially as such a change would likely only benefit the larger, more resourceful 
+During this last release cycle I thought a lot more about multi-language support within BookStack, 
+but ran into significant doubts about it about it being worthwhile to make significant content changes in order to support this
+due to the complexity it'd add; especially as such a change would likely only benefit the larger, more resourceful 

 BookStack users while having a development impact for everyone. 
 I wanted to think about potential alternative options that don't require so much foundational change, so I posted
 a question [within the issue thread](https://github.com/BookStackApp/BookStack/issues/569#issuecomment-1501145217)
 BookStack users while having a development impact for everyone. 
 I wanted to think about potential alternative options that don't require so much foundational change, so I posted
 a question [within the issue thread](https://github.com/BookStackApp/BookStack/issues/569#issuecomment-1501145217)

-to gain feedback to help explore what exactly people are lacking right now. 
-If you have a need to support multi-lingual content within BookStack, I've welcome your response to that.
+to gain feedback and help explore what exactly people are lacking right now. 
+If you have a need to support multi-lingual content within BookStack, I'd welcome your response to that.

 
 Right now there's fair demand in regards to features surrounding comments and notifications, both areas untouched
 in quite a while apart from the addition of webhooks.
 I'd like to spend some time in these areas. Notifications in general is very complex topic, at least when you consider
 
 Right now there's fair demand in regards to features surrounding comments and notifications, both areas untouched
 in quite a while apart from the addition of webhooks.
 I'd like to spend some time in these areas. Notifications in general is very complex topic, at least when you consider

-the levels of preferences and control that people may desire/need. 
+the levels of preferences and control that people may desire or require. 

 It may be the case I tackle some minor issues in these areas, to help form questions and ideas that I can take to the 
 It may be the case I tackle some minor issues in these areas, to help form questions and ideas that I can take to the 

-wider community to help establish a path forward to the more significant features here.
+wider community to help establish a path forward towards the more significant features here.

 
 The image upload work in this release reminded me that the image manager is a little old.
 
 The image upload work in this release reminded me that the image manager is a little old.

-While I neatened a few parts for v23.05, it's still very much non-mobile-friendly and I don't think it's very screen-reader accessible either, so I'd like to overhaul things a tad to bring them up to standards.
+While I neatened a few parts for v23.05, it's still very much non-mobile-friendly and I don't think it's very accessible either, so I'd like to overhaul things a tad to bring them up to standards.

 
 ### Other Updates
 
 
 ### Other Updates
 


@@ -219,7 +247,7 @@ new hacks and API scripts.
 * Added support for three-levels of nested include tags. Thanks to [@jasonF1000](https://github.com/BookStackApp/BookStack/pull/4192). ([#4192](https://github.com/BookStackApp/BookStack/pull/4192), [#2845](https://github.com/BookStackApp/BookStack/issues/2845))
 * Added detailed documentation for public JS events. ([#4179](https://github.com/BookStackApp/BookStack/issues/4179))
 * Added standard JS codebase formatting via ESLint. ([#4181](https://github.com/BookStackApp/BookStack/pull/4181), [#4180](https://github.com/BookStackApp/BookStack/issues/4180))
 * Added support for three-levels of nested include tags. Thanks to [@jasonF1000](https://github.com/BookStackApp/BookStack/pull/4192). ([#4192](https://github.com/BookStackApp/BookStack/pull/4192), [#2845](https://github.com/BookStackApp/BookStack/issues/2845))
 * Added detailed documentation for public JS events. ([#4179](https://github.com/BookStackApp/BookStack/issues/4179))
 * Added standard JS codebase formatting via ESLint. ([#4181](https://github.com/BookStackApp/BookStack/pull/4181), [#4180](https://github.com/BookStackApp/BookStack/issues/4180))

-* Updated code blocks & markdown editor to CodeMirror 6. ([#3617](https://github.com/BookStackApp/BookStack/pull/3617), https://github.com/BookStackApp/BookStack/issues/3518))
+* Updated code blocks & markdown editor to CodeMirror 6. ([#3617](https://github.com/BookStackApp/BookStack/pull/3617), [#3518](https://github.com/BookStackApp/BookStack/issues/3518))

 * Updated file upload handling for images and attachments. ([#4193](https://github.com/BookStackApp/BookStack/pull/4193))
 * Updated SAML2 SLO requests to include a session index. ([#3936](https://github.com/BookStackApp/BookStack/issues/3936))
 * Updated translations with latest Crowdin changes. ([#4163](https://github.com/BookStackApp/BookStack/pull/4163))
 * Updated file upload handling for images and attachments. ([#4193](https://github.com/BookStackApp/BookStack/pull/4193))
 * Updated SAML2 SLO requests to include a session index. ([#3936](https://github.com/BookStackApp/BookStack/issues/3936))
 * Updated translations with latest Crowdin changes. ([#4163](https://github.com/BookStackApp/BookStack/pull/4163))

diff --git a/content/docs/admin/updates.md b/content/docs/admin/updates.md
index 804b38fb691b7bf8fd5d1c67742c73224baf3e26..51ff2236c28ca30fc829d52809b47c2b3246796c 100644 (file)
--- a/content/docs/admin/updates.md
+++ b/content/docs/admin/updates.md
@@ -41,6 +41,20 @@ This is primarily a list of breaking changes & security notices.
 Details of updates can be found on [our blog](https://www.bookstackapp.com/blog/) or via 
 the [GitHub releases page](https://github.com/BookStackApp/BookStack/releases).
 
 Details of updates can be found on [our blog](https://www.bookstackapp.com/blog/) or via 
 the [GitHub releases page](https://github.com/BookStackApp/BookStack/releases).
 

+#### Updating to v23.05 or higher
+
+**Page Include Tags** - Nesting is now allowed for [include tags](https://www.bookstackapp.com/docs/user/reusing-page-content/#include-tags), up to 3 levels of depth. You may now see more content loaded for pages which previously had unparsed nested include tags.
+
+**SAML2** - Single LogOut (SLO) requests will now include a "session_index" for the current user. This technically brings BookStack's implementation closer to the spec, and is not expected to cause issues, but if using SLO it may be wise to check your identity provider behavior remains the same as before during logout.
+
+**Custom Code Block Themes** - Due to a change of library, the method of defining custom codeblock themes has significantly changed, and "window.CodeTheme" code is no longer used. Refer to our ["Changing Code Block Themes"](https://www.bookstackapp.com/docs/admin/visual-customisation/#changing-code-block-themes) documentation for further information.
+
+**Editor Event - editor-markdown::setup** - This event no longer contains "codeMirrorInstance" in the event data. It instead has a "cmEditorView" property. [See the event docs for more details](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/javascript-public-events.md#editor-markdownsetup).
+
+**Editor Event - editor-markdown-cm::pre-init** - This event has been renamed to "editor-markdown-cm6::pre-init" and no longer contains "config" in the event data. It instead has a "editorViewConfig" property. [See the event docs for more details](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/javascript-public-events.md#editor-markdown-cm6pre-init).
+
+**Upload Timeouts** - The use of "window.uploadTimeout" has been removed as a way to control upload timeouts. This would previously only be used in certain cases. Instead, if required, timeouts can usually be enforced at the web-server level.
+

 #### Updating to v23.02 or higher
 
 **PHP Version Requirement Change** - The minimum required version of PHP has changed from 7.4 to 8.0.2. This should not be a concern for those that are using common containers. Installations via our Ubuntu 22.04 install script are already using PHP 8.1 and therefore they don't need to be upgraded at this time.
 #### Updating to v23.02 or higher
 
 **PHP Version Requirement Change** - The minimum required version of PHP has changed from 7.4 to 8.0.2. This should not be a concern for those that are using common containers. Installations via our Ubuntu 22.04 install script are already using PHP 8.1 and therefore they don't need to be upgraded at this time.