From 5f752ee4b5a1042958968afcb53ee1058779565f Mon Sep 17 00:00:00 2001 From: Ella Date: Wed, 4 Mar 2026 02:25:31 +0000 Subject: [PATCH 1/9] save draft --- .../what-is-the-site-dashboard-readme.mdx | 96 +++++++++++++++++++ 1 file changed, 96 insertions(+) create mode 100755 developer/articles/what-is-the-site-dashboard-readme.mdx diff --git a/developer/articles/what-is-the-site-dashboard-readme.mdx b/developer/articles/what-is-the-site-dashboard-readme.mdx new file mode 100755 index 000000000..2dc1157b2 --- /dev/null +++ b/developer/articles/what-is-the-site-dashboard-readme.mdx @@ -0,0 +1,96 @@ +--- +_schema: default +_uuid: d75e8f1d-cf52-48cc-827d-8e8546015dde +_created_at: 2026-03-04T15:16:15+13:00 +details: + title: What is the Site Dashboard README? + description: >- + Learn about customizing your Site Dashboard with a README file in + CloudCannon. + image: >- + https://cc-dam.imgix.net/documentation/images/default-thumbnail/2023-Q4/CloudCannon-Documentation-Thumbnail.png + category: + - Explanation + related_articles: + - _type: developer_articles + item: 37ee41fa-8ac5-407b-b9c3-6fe1ecac6e1e + - _type: user_articles + item: +author_notes: + docshots: Needs docshots + custom_search_weight: +--- +The *Site Dashboard* README is a Markdown file at `.cloudcannon/README.md` in your Git repository that displays custom content on your *Site Dashboard*. You can use it to provide onboarding notes, project documentation, editing guidelines, or links to external resources for your team members. + +When CloudCannon detects a `.cloudcannon/README.md` file in your *Site* files, it renders the Markdown content on the *Summary* tab of your *Site Dashboard*. This is useful for surfacing important information that your team should see when they first open a *Site*. + +## Supported formatting + +The *Site Dashboard* README supports a wide range of Markdown formatting: + +* Headings +* Bold, italic, strikethrough, subscript, superscript, and underline +* Links +* Blockquotes +* Bulleted and numbered lists +* Inline code +* Fenced code blocks with syntax highlighting +* Horizontal rules +* Tables + +### Headings + +CloudCannon automatically adjusts heading levels in your README to fit within the *Site Dashboard* layout. Your heading hierarchy is preserved, but levels are shifted so they appear as sub-headings within the dashboard. You can write headings naturally starting from `#` without worrying about the dashboard context. + +For example, if your README contains `#`, `##`, and `###` headings, CloudCannon shifts them to render as smaller headings that sit beneath the dashboard page headings. + +### Code blocks + +Fenced code blocks in your README render with syntax highlighting using CloudCannon's styled code block component. Specify a language after the opening backticks for language-specific highlighting. + +For example, the following Markdown in your README: + + +``` +## Configuration + +Create a config file with the following: + +```yaml +title: My Site +description: A great site +``` +``` + + +This renders on the *Site Dashboard* with a styled code block that includes syntax highlighting, line numbers, and a copy button. + +## Adding a README + +There are two ways to add a README to your *Site Dashboard*. + +**From the Site Dashboard:** + +1. Open your *Site Dashboard* and navigate to the *Summary* tab. +2. Click the *Add README* button. CloudCannon will create a `.cloudcannon/README.md` file and open it in the *Content Editor*. +3. Add your content and click *Save*. + +**From your Git repository:** + +1. Create a file at `.cloudcannon/README.md` in your repository. +2. Add your Markdown content and commit the file. +3. CloudCannon will display the content on your *Site Dashboard* after your next sync. + + + The file path is case-insensitive. CloudCannon recognizes `.cloudcannon/README.md`, `.cloudcannon/readme.md`, and other case variations. + + +## Editing your README + +You can edit your README file in the *Content Editor*, which provides a rich text toolbar with formatting options for all supported Markdown features. To open your README for editing, click the *Edit README* button on the *Site Dashboard*. + +You can also edit the file directly in your Git repository or through the *File Browser* in CloudCannon. + +## Related resources + +For more information about the `.cloudcannon` directory and other configuration options, please read our documentation on the [CloudCannon Configuration File](/documentation/developer-articles/what-is-the-cloudcannon-configuration-file/). \ No newline at end of file From 809bd9cd18fc85855862d0f88e94510a857f8e64 Mon Sep 17 00:00:00 2001 From: Ella Date: Wed, 4 Mar 2026 19:42:15 +0000 Subject: [PATCH 2/9] more draft --- .../2026/03-05_site-dashboard-readme.mdx | 33 +++++++++++++++++++ .../what-is-the-site-dashboard-readme.mdx | 2 -- 2 files changed, 33 insertions(+), 2 deletions(-) create mode 100755 changelogs/2026/03-05_site-dashboard-readme.mdx diff --git a/changelogs/2026/03-05_site-dashboard-readme.mdx b/changelogs/2026/03-05_site-dashboard-readme.mdx new file mode 100755 index 000000000..c4855cbd2 --- /dev/null +++ b/changelogs/2026/03-05_site-dashboard-readme.mdx @@ -0,0 +1,33 @@ +--- +_schema: default +title: Site Dashboard README +date: 2026-03-05T08:41:01+13:00 +--- +This release added... + +It also addressed several issues, including those affecting... + +## Features & Improvements + +*   + +## Fixes + +* Fixed an issue where... +* Updated dependencies to patch security vulnerabilities. +*   + +   + +   + +This release added the *Site Dashboard README*, allowing you to display custom Markdown content on your *Site Dashboard* using a `.cloudcannon/README.md` file. It also redesigned the welcome screen for new *Organizations*, improved Markdown rendering in *Context* boxes, and updated the heading hierarchy across the app for better accessibility. + +## Features & Improvements + +* Added the *Site Dashboard README*. You can now create a `.cloudcannon/README.md` file in your repository to display custom content on the *Site Dashboard*. This file supports rich Markdown formatting, including headings, bold, italic, strikethrough, links, blockquotes, ordered and unordered lists, tables, horizontal rules, inline code, and fenced code blocks with syntax highlighting. +* Improved Markdown rendering in *Context* boxes for *Inputs*. *Context* boxes now support fenced code blocks with syntax highlighting. +* CloudCannon now automatically adjusts heading levels in the *Site Dashboard README* and *Context* boxes to fit correctly within the page hierarchy. +* Redesigned the welcome screen for new *Organizations*. When you have no *Sites*, CloudCannon now presents two options: try a demo site or connect your own repository. +* Improved the heading hierarchy across the app for better accessibility and screen reader support. +* Updated the typography scale so all six heading levels (`h1`–`h6`) are properly styled and visually distinct. \ No newline at end of file diff --git a/developer/articles/what-is-the-site-dashboard-readme.mdx b/developer/articles/what-is-the-site-dashboard-readme.mdx index 2dc1157b2..9d0856944 100755 --- a/developer/articles/what-is-the-site-dashboard-readme.mdx +++ b/developer/articles/what-is-the-site-dashboard-readme.mdx @@ -14,8 +14,6 @@ details: related_articles: - _type: developer_articles item: 37ee41fa-8ac5-407b-b9c3-6fe1ecac6e1e - - _type: user_articles - item: author_notes: docshots: Needs docshots custom_search_weight: From 9b1c75d1deeb55e094cbe5cf38e21149e667e056 Mon Sep 17 00:00:00 2001 From: Ella <141297015+EllaCloudCannon@users.noreply.github.com> Date: Thu, 5 Mar 2026 09:35:07 +1300 Subject: [PATCH 3/9] update readme articles --- _data/navigation/developer-articles.yml | 7 +++ .../articles/add-a-site-dashboard-readme.mdx | 57 +++++++++++++++++ .../what-is-the-site-dashboard-readme.mdx | 62 ++++++++----------- 3 files changed, 91 insertions(+), 35 deletions(-) create mode 100644 developer/articles/add-a-site-dashboard-readme.mdx diff --git a/_data/navigation/developer-articles.yml b/_data/navigation/developer-articles.yml index bc75e8e03..2a72929a3 100755 --- a/_data/navigation/developer-articles.yml +++ b/_data/navigation/developer-articles.yml @@ -68,6 +68,13 @@ headings: articles: - 0f1a2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c - 4ac13946-f88d-47e9-8705-c2ea1f982cb1 + - _type: group + name: Site README + items: + - _type: items + articles: + - d75e8f1d-cf52-48cc-827d-8e8546015dde + - bf4cc23c-8aae-46fc-9a4c-ad786a061811 - _type: group name: Cards items: diff --git a/developer/articles/add-a-site-dashboard-readme.mdx b/developer/articles/add-a-site-dashboard-readme.mdx new file mode 100644 index 000000000..df83f9d94 --- /dev/null +++ b/developer/articles/add-a-site-dashboard-readme.mdx @@ -0,0 +1,57 @@ +--- +_schema: default +_uuid: bf4cc23c-8aae-46fc-9a4c-ad786a061811 +_created_at: 2026-03-05T00:00:00+00:00 +details: + title: Add a Site Dashboard README + description: >- + Learn how to add and edit a README file on your Site Dashboard in + CloudCannon. + image: >- + https://cc-dam.imgix.net/documentation/images/default-thumbnail/2023-Q4/CloudCannon-Documentation-Thumbnail.png + category: + - Instructions + related_articles: + - _type: developer_articles + item: d75e8f1d-cf52-48cc-827d-8e8546015dde + - _type: developer_articles + item: 37ee41fa-8ac5-407b-b9c3-6fe1ecac6e1e +author_notes: + docshots: Needs docshots + custom_search_weight: +--- +The [Site Dashboard README](/documentation/developer-articles/what-is-the-site-dashboard-readme/) file displays custom Markdown content on the *Summary* tab of your *Site Dashboard*, giving your team immediate access to project information. + +You can add a README to your *Site Dashboard* from the *Site Dashboard* using Configuration Mode, or by creating the file directly in your Local Development Environment. + +## Add a README from the Site Dashboard + +To add a README using *Configuration Mode*: + +1. Navigate to the *Summary* tab on your *Site Dashboard*. +2. Click the *Configuration Mode* switch on the right of the *Site Header* to turn it on. +3. Click the *Add README* button. CloudCannon will create a `.cloudcannon/README.md` file and open it in the Content Editor. +4. Add your content. + +CloudCannon will automatically display your README content on the *Summary* tab of the *Site Dashboard*. When you are happy with your content, save your file back to your *Git Repository*. + + + +## Add a README from your IDE + +To add a README directly in your repository: + +1. Create a file at `.cloudcannon/README.md` in your Git repository. +2. Add your Markdown content and commit the file *Git Repository*. + +CloudCannon will automatically sync the changes to your *Git Repository* and display your README content on the *Summary* tab of the *Site Dashboard*. + + + The file path is case-insensitive. CloudCannon recognizes `.cloudcannon/README.md`, `.cloudcannon/readme.md`, and other case variations. + + +## Edit your README + +You can edit your README file in CloudCannon using the *Content Editor*. To open your README for in the *Content* Editor*, turn on *Configuration Mode* and click the *Edit README* button on the *Site Dashboard*. + +You can also edit the file directly in your *IDE* or through the *File Browser* in CloudCannon. \ No newline at end of file diff --git a/developer/articles/what-is-the-site-dashboard-readme.mdx b/developer/articles/what-is-the-site-dashboard-readme.mdx index 9d0856944..1ee16a5fb 100755 --- a/developer/articles/what-is-the-site-dashboard-readme.mdx +++ b/developer/articles/what-is-the-site-dashboard-readme.mdx @@ -5,22 +5,42 @@ _created_at: 2026-03-04T15:16:15+13:00 details: title: What is the Site Dashboard README? description: >- - Learn about customizing your Site Dashboard with a README file in - CloudCannon. + Learn about the Site Dashboard README and how it helps your team access + important project information in CloudCannon. image: >- https://cc-dam.imgix.net/documentation/images/default-thumbnail/2023-Q4/CloudCannon-Documentation-Thumbnail.png category: - Explanation related_articles: + - _type: developer_articles + item: bf4cc23c-8aae-46fc-9a4c-ad786a061811 - _type: developer_articles item: 37ee41fa-8ac5-407b-b9c3-6fe1ecac6e1e author_notes: docshots: Needs docshots custom_search_weight: --- -The *Site Dashboard* README is a Markdown file at `.cloudcannon/README.md` in your Git repository that displays custom content on your *Site Dashboard*. You can use it to provide onboarding notes, project documentation, editing guidelines, or links to external resources for your team members. +You can add more context and instructions to your *Site* by adding a the `.cloudcannon/README.md` Markdown file to your *Site*. When CloudCannon detects this file, it will render the contents on the *Summary* tab of your Site Dashboard. + + + +## Why add a README to your *Site Dashboard*? + +The *Summary* tab of your *Site Dashboard* is a hub for information about your *Site*. It is the first page you see when you open your *Site*, and summarizes useful information such as *Recent Activity*, *Syncs*, *Builds*, and *Usage*. This make it an excellent page to add more information for your *Site* users. + +A *Site Dashboard* README gives your team a single place to find essential project information without leaving CloudCannon. Instead of relying on external documents, emails, or team knowledge, you can put everything your team needs right where they work. You can use it to provide onboarding notes, project documentation, editing guidelines, or links to external resources for your team members. This is especially valuable for onboarding. When a new team member opens a *Site* for the first time, the README is the first thing they see on the *Summary* tab, giving them immediate context about the project and how to contribute. -When CloudCannon detects a `.cloudcannon/README.md` file in your *Site* files, it renders the Markdown content on the *Summary* tab of your *Site Dashboard*. This is useful for surfacing important information that your team should see when they first open a *Site*. +You can include any information that helps your team work more effectively, such as: + +* Onboarding notes for new team members +* Editing guidelines and content conventions (e.g., required front matter fields, recommended image dimensions) +* Links to external resources like design systems, brand guides, or project management boards +* Build or deployment notes relevant to the *Site* +* Contact information for the project owner or technical lead + +Because the README is stored in your Git repository alongside your *Site* files, you can easily maintain versions of the file that are up to date with the rest of your project. + +For instructions on how to create and edit your *Site* README, please read our documentation on how to [add a Site Dashboard README](/documentation/developer-articles/add-a-site-dashboard-readme/). ## Supported formatting @@ -54,41 +74,13 @@ For example, the following Markdown in your README: Create a config file with the following: -```yaml +yaml title: My Site description: A great site -``` +sdfg ``` This renders on the *Site Dashboard* with a styled code block that includes syntax highlighting, line numbers, and a copy button. -## Adding a README - -There are two ways to add a README to your *Site Dashboard*. - -**From the Site Dashboard:** - -1. Open your *Site Dashboard* and navigate to the *Summary* tab. -2. Click the *Add README* button. CloudCannon will create a `.cloudcannon/README.md` file and open it in the *Content Editor*. -3. Add your content and click *Save*. - -**From your Git repository:** - -1. Create a file at `.cloudcannon/README.md` in your repository. -2. Add your Markdown content and commit the file. -3. CloudCannon will display the content on your *Site Dashboard* after your next sync. - - - The file path is case-insensitive. CloudCannon recognizes `.cloudcannon/README.md`, `.cloudcannon/readme.md`, and other case variations. - - -## Editing your README - -You can edit your README file in the *Content Editor*, which provides a rich text toolbar with formatting options for all supported Markdown features. To open your README for editing, click the *Edit README* button on the *Site Dashboard*. - -You can also edit the file directly in your Git repository or through the *File Browser* in CloudCannon. - -## Related resources - -For more information about the `.cloudcannon` directory and other configuration options, please read our documentation on the [CloudCannon Configuration File](/documentation/developer-articles/what-is-the-cloudcannon-configuration-file/). \ No newline at end of file + \ No newline at end of file From c84757c0283505d5e314127492559450f579540b Mon Sep 17 00:00:00 2001 From: Ella Date: Wed, 4 Mar 2026 20:52:20 +0000 Subject: [PATCH 4/9] update docs --- .../articles/add-a-site-dashboard-readme.mdx | 8 +++----- .../what-is-the-site-dashboard-readme.mdx | 16 ++++++---------- 2 files changed, 9 insertions(+), 15 deletions(-) diff --git a/developer/articles/add-a-site-dashboard-readme.mdx b/developer/articles/add-a-site-dashboard-readme.mdx index df83f9d94..7ff683f14 100644 --- a/developer/articles/add-a-site-dashboard-readme.mdx +++ b/developer/articles/add-a-site-dashboard-readme.mdx @@ -1,7 +1,7 @@ --- _schema: default _uuid: bf4cc23c-8aae-46fc-9a4c-ad786a061811 -_created_at: 2026-03-05T00:00:00+00:00 +_created_at: 2026-03-05T00:00:00Z details: title: Add a Site Dashboard README description: >- @@ -24,7 +24,7 @@ The [Site Dashboard README](/documentation/developer-articles/what-is-the-site-d You can add a README to your *Site Dashboard* from the *Site Dashboard* using Configuration Mode, or by creating the file directly in your Local Development Environment. -## Add a README from the Site Dashboard +## Add a README from the *Site Dashboard* To add a README using *Configuration Mode*: @@ -35,8 +35,6 @@ To add a README using *Configuration Mode*: CloudCannon will automatically display your README content on the *Summary* tab of the *Site Dashboard*. When you are happy with your content, save your file back to your *Git Repository*. - - ## Add a README from your IDE To add a README directly in your repository: @@ -52,6 +50,6 @@ CloudCannon will automatically sync the changes to your *Git Repository* and dis ## Edit your README -You can edit your README file in CloudCannon using the *Content Editor*. To open your README for in the *Content* Editor*, turn on *Configuration Mode* and click the *Edit README* button on the *Site Dashboard*. +You can edit your README file in CloudCannon using the *Content Editor*. To open your README for in the *Content* Editor\*, turn on *Configuration Mode* and click the *Edit README* button on the *Site Dashboard*. You can also edit the file directly in your *IDE* or through the *File Browser* in CloudCannon. \ No newline at end of file diff --git a/developer/articles/what-is-the-site-dashboard-readme.mdx b/developer/articles/what-is-the-site-dashboard-readme.mdx index 1ee16a5fb..714b47f0f 100755 --- a/developer/articles/what-is-the-site-dashboard-readme.mdx +++ b/developer/articles/what-is-the-site-dashboard-readme.mdx @@ -22,8 +22,6 @@ author_notes: --- You can add more context and instructions to your *Site* by adding a the `.cloudcannon/README.md` Markdown file to your *Site*. When CloudCannon detects this file, it will render the contents on the *Summary* tab of your Site Dashboard. - - ## Why add a README to your *Site Dashboard*? The *Summary* tab of your *Site Dashboard* is a hub for information about your *Site*. It is the first page you see when you open your *Site*, and summarizes useful information such as *Recent Activity*, *Syncs*, *Builds*, and *Usage*. This make it an excellent page to add more information for your *Site* users. @@ -40,7 +38,7 @@ You can include any information that helps your team work more effectively, such Because the README is stored in your Git repository alongside your *Site* files, you can easily maintain versions of the file that are up to date with the rest of your project. -For instructions on how to create and edit your *Site* README, please read our documentation on how to [add a Site Dashboard README](/documentation/developer-articles/add-a-site-dashboard-readme/). +For instructions on how to create and edit your *Site* README, please read [add a Site Dashboard README](/documentation/developer-articles/add-a-site-dashboard-readme/). ## Supported formatting @@ -70,17 +68,15 @@ For example, the following Markdown in your README: ``` -## Configuration +## Heading -Create a config file with the following: +Description: -yaml +```yaml title: My Site description: A great site -sdfg +``` ``` -This renders on the *Site Dashboard* with a styled code block that includes syntax highlighting, line numbers, and a copy button. - - \ No newline at end of file +This renders on the *Site Dashboard* with a styled code block that includes syntax highlighting, line numbers, and a copy button. \ No newline at end of file From ac749706d96becdd5731f6813ba210663930e9e3 Mon Sep 17 00:00:00 2001 From: Ella Date: Wed, 4 Mar 2026 21:06:25 +0000 Subject: [PATCH 5/9] update copy --- .../articles/add-a-site-dashboard-readme.mdx | 2 +- .../what-is-the-site-dashboard-readme.mdx | 18 +++++++++++++++++- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/developer/articles/add-a-site-dashboard-readme.mdx b/developer/articles/add-a-site-dashboard-readme.mdx index 7ff683f14..82ee2d512 100644 --- a/developer/articles/add-a-site-dashboard-readme.mdx +++ b/developer/articles/add-a-site-dashboard-readme.mdx @@ -50,6 +50,6 @@ CloudCannon will automatically sync the changes to your *Git Repository* and dis ## Edit your README -You can edit your README file in CloudCannon using the *Content Editor*. To open your README for in the *Content* Editor\*, turn on *Configuration Mode* and click the *Edit README* button on the *Site Dashboard*. +You can edit your README file in CloudCannon using the [Content Editor](/documentation/user-articles/what-is-the-content-editor/). To open your README for in the *Content* *Editor*, turn on *Configuration Mode* and click the *Edit README* button on the *Site Dashboard*. You can also edit the file directly in your *IDE* or through the *File Browser* in CloudCannon. \ No newline at end of file diff --git a/developer/articles/what-is-the-site-dashboard-readme.mdx b/developer/articles/what-is-the-site-dashboard-readme.mdx index 714b47f0f..6b6b0dd60 100755 --- a/developer/articles/what-is-the-site-dashboard-readme.mdx +++ b/developer/articles/what-is-the-site-dashboard-readme.mdx @@ -79,4 +79,20 @@ description: A great site ``` -This renders on the *Site Dashboard* with a styled code block that includes syntax highlighting, line numbers, and a copy button. \ No newline at end of file +This renders on the *Site Dashboard* with a styled code block that includes syntax highlighting, line numbers, and a copy button. + +### CloudCannon links + +You can add links to CloudCannon pages using the [CloudCannon link protocol](/documentation/developer-articles/cloudcannon-protocol/). This allows you to link directly to a page on CloudCannon, such as a file or *Collection* on your *Site*, or to relevant pages outside your *Site*, such as the *Custom Domain* or *Project Browser*. + +For example: + + +``` +## Quick links + +* [Edit the home page](cloudcannon:collections/pages/index.md) +* [View all blog posts](cloudcannon:collections/posts) +* [Site Settings](cloudcannon:settings) +``` + \ No newline at end of file From 9597cf4b1645f249693e591999100e437fdd15b6 Mon Sep 17 00:00:00 2001 From: Ella Date: Wed, 4 Mar 2026 21:19:28 +0000 Subject: [PATCH 6/9] add docshots and chlog --- .../changelog.cloudcannon.collections.yml | 2 +- _data/docshots.yml | 2 +- .../2026/03-05_site-dashboard-readme.mdx | 26 ++++++------------- .../articles/add-a-site-dashboard-readme.mdx | 6 ++++- .../what-is-the-site-dashboard-readme.mdx | 2 ++ 5 files changed, 17 insertions(+), 21 deletions(-) diff --git a/.cloudcannon/collections/changelog.cloudcannon.collections.yml b/.cloudcannon/collections/changelog.cloudcannon.collections.yml index 59a9d8345..ce8b2ec9d 100755 --- a/.cloudcannon/collections/changelog.cloudcannon.collections.yml +++ b/.cloudcannon/collections/changelog.cloudcannon.collections.yml @@ -5,7 +5,7 @@ changelog: disable_url: false sort_options: - key: path - order: ascending + order: descending _inputs: title: type: text diff --git a/_data/docshots.yml b/_data/docshots.yml index bfd223916..d9e20d3f0 100644 --- a/_data/docshots.yml +++ b/_data/docshots.yml @@ -1 +1 @@ -source: main_7a98e60ce3b2b5dbd1380b21963584b2ed20198a +source: main_200379a664287d04af7579c591be3715d26def7c diff --git a/changelogs/2026/03-05_site-dashboard-readme.mdx b/changelogs/2026/03-05_site-dashboard-readme.mdx index c4855cbd2..550f7c370 100755 --- a/changelogs/2026/03-05_site-dashboard-readme.mdx +++ b/changelogs/2026/03-05_site-dashboard-readme.mdx @@ -3,31 +3,21 @@ _schema: default title: Site Dashboard README date: 2026-03-05T08:41:01+13:00 --- -This release added... +This release added the *Site Dashboard* README file, redesigned the welcome screen for new *Organizations*, improved Markdown rendering in *Context* boxes, and updated the heading hierarchy across the app for better accessibility. It also addressed several issues, including those affecting... ## Features & Improvements -*   +*  Added the *Site Dashboard README*. You can now create a `.cloudcannon/README.md` file in your repository to display custom content on the *Site Dashboard*. For more information, please read our documentation [What is the Site Dashboard README](/documentation/developer-articles/what-is-the-site-dashboard-readme/) and [Add a Site Dashboard README](/documentation/developer-articles/add-a-site-dashboard-readme/). +* Improved Markdown rendering in *Context* boxes for *Inputs*. *Context* boxes now support fenced code blocks with syntax highlighting. +* CloudCannon now automatically adjusts heading levels in the *Site Dashboard README* and *Context* boxes to fit correctly within the page hierarchy. +* Improved the heading hierarchy across the app for better accessibility and screen reader support. +* Updated the typography scale so all six heading levels (`h1`–`h6`) are properly styled and visually distinct. +* Redesigned the welcome screen for new *Organizations*. When you have no *Sites*, CloudCannon now presents two options: try a demo site or connect your own repository. ## Fixes * Fixed an issue where... * Updated dependencies to patch security vulnerabilities. -*   - -   - -   - -This release added the *Site Dashboard README*, allowing you to display custom Markdown content on your *Site Dashboard* using a `.cloudcannon/README.md` file. It also redesigned the welcome screen for new *Organizations*, improved Markdown rendering in *Context* boxes, and updated the heading hierarchy across the app for better accessibility. - -## Features & Improvements - -* Added the *Site Dashboard README*. You can now create a `.cloudcannon/README.md` file in your repository to display custom content on the *Site Dashboard*. This file supports rich Markdown formatting, including headings, bold, italic, strikethrough, links, blockquotes, ordered and unordered lists, tables, horizontal rules, inline code, and fenced code blocks with syntax highlighting. -* Improved Markdown rendering in *Context* boxes for *Inputs*. *Context* boxes now support fenced code blocks with syntax highlighting. -* CloudCannon now automatically adjusts heading levels in the *Site Dashboard README* and *Context* boxes to fit correctly within the page hierarchy. -* Redesigned the welcome screen for new *Organizations*. When you have no *Sites*, CloudCannon now presents two options: try a demo site or connect your own repository. -* Improved the heading hierarchy across the app for better accessibility and screen reader support. -* Updated the typography scale so all six heading levels (`h1`–`h6`) are properly styled and visually distinct. \ No newline at end of file +*   \ No newline at end of file diff --git a/developer/articles/add-a-site-dashboard-readme.mdx b/developer/articles/add-a-site-dashboard-readme.mdx index 82ee2d512..eaacb59cb 100644 --- a/developer/articles/add-a-site-dashboard-readme.mdx +++ b/developer/articles/add-a-site-dashboard-readme.mdx @@ -35,6 +35,8 @@ To add a README using *Configuration Mode*: CloudCannon will automatically display your README content on the *Summary* tab of the *Site Dashboard*. When you are happy with your content, save your file back to your *Git Repository*. + + ## Add a README from your IDE To add a README directly in your repository: @@ -52,4 +54,6 @@ CloudCannon will automatically sync the changes to your *Git Repository* and dis You can edit your README file in CloudCannon using the [Content Editor](/documentation/user-articles/what-is-the-content-editor/). To open your README for in the *Content* *Editor*, turn on *Configuration Mode* and click the *Edit README* button on the *Site Dashboard*. -You can also edit the file directly in your *IDE* or through the *File Browser* in CloudCannon. \ No newline at end of file +You can also edit the file directly in your *IDE* or through the *File Browser* in CloudCannon. + + \ No newline at end of file diff --git a/developer/articles/what-is-the-site-dashboard-readme.mdx b/developer/articles/what-is-the-site-dashboard-readme.mdx index 6b6b0dd60..f99e14c26 100755 --- a/developer/articles/what-is-the-site-dashboard-readme.mdx +++ b/developer/articles/what-is-the-site-dashboard-readme.mdx @@ -22,6 +22,8 @@ author_notes: --- You can add more context and instructions to your *Site* by adding a the `.cloudcannon/README.md` Markdown file to your *Site*. When CloudCannon detects this file, it will render the contents on the *Summary* tab of your Site Dashboard. + + ## Why add a README to your *Site Dashboard*? The *Summary* tab of your *Site Dashboard* is a hub for information about your *Site*. It is the first page you see when you open your *Site*, and summarizes useful information such as *Recent Activity*, *Syncs*, *Builds*, and *Usage*. This make it an excellent page to add more information for your *Site* users. From 0ac300cb4655c2f6a23e0d6de411c50f89a12bef Mon Sep 17 00:00:00 2001 From: Ella Date: Wed, 4 Mar 2026 21:29:34 +0000 Subject: [PATCH 7/9] add image title and alt text --- developer/articles/add-a-site-dashboard-readme.mdx | 4 ++-- developer/articles/what-is-the-site-dashboard-readme.mdx | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/developer/articles/add-a-site-dashboard-readme.mdx b/developer/articles/add-a-site-dashboard-readme.mdx index eaacb59cb..5a8bd1dbf 100644 --- a/developer/articles/add-a-site-dashboard-readme.mdx +++ b/developer/articles/add-a-site-dashboard-readme.mdx @@ -35,7 +35,7 @@ To add a README using *Configuration Mode*: CloudCannon will automatically display your README content on the *Summary* tab of the *Site Dashboard*. When you are happy with your content, save your file back to your *Git Repository*. - + ## Add a README from your IDE @@ -56,4 +56,4 @@ You can edit your README file in CloudCannon using the [Content Editor](/documen You can also edit the file directly in your *IDE* or through the *File Browser* in CloudCannon. - \ No newline at end of file + \ No newline at end of file diff --git a/developer/articles/what-is-the-site-dashboard-readme.mdx b/developer/articles/what-is-the-site-dashboard-readme.mdx index f99e14c26..d90ed2841 100755 --- a/developer/articles/what-is-the-site-dashboard-readme.mdx +++ b/developer/articles/what-is-the-site-dashboard-readme.mdx @@ -22,7 +22,7 @@ author_notes: --- You can add more context and instructions to your *Site* by adding a the `.cloudcannon/README.md` Markdown file to your *Site*. When CloudCannon detects this file, it will render the contents on the *Summary* tab of your Site Dashboard. - + ## Why add a README to your *Site Dashboard*? From f2851918d00fb50c686e70e5c92ec6f279b3f777 Mon Sep 17 00:00:00 2001 From: Ella Date: Thu, 5 Mar 2026 03:29:44 +0000 Subject: [PATCH 8/9] update chlog copy --- .../2026/03-05_site-dashboard-readme.mdx | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/changelogs/2026/03-05_site-dashboard-readme.mdx b/changelogs/2026/03-05_site-dashboard-readme.mdx index 550f7c370..dbde23281 100755 --- a/changelogs/2026/03-05_site-dashboard-readme.mdx +++ b/changelogs/2026/03-05_site-dashboard-readme.mdx @@ -9,15 +9,26 @@ It also addressed several issues, including those affecting... ## Features & Improvements -*  Added the *Site Dashboard README*. You can now create a `.cloudcannon/README.md` file in your repository to display custom content on the *Site Dashboard*. For more information, please read our documentation [What is the Site Dashboard README](/documentation/developer-articles/what-is-the-site-dashboard-readme/) and [Add a Site Dashboard README](/documentation/developer-articles/add-a-site-dashboard-readme/). +* Added the *Site Dashboard README*. You can now create a `.cloudcannon/README.md` file in your repository to display custom content on the *Site Dashboard*. For more information, please read our documentation [What is the Site Dashboard README](/documentation/developer-articles/what-is-the-site-dashboard-readme/) and [Add a Site Dashboard README](/documentation/developer-articles/add-a-site-dashboard-readme/). * Improved Markdown rendering in *Context* boxes for *Inputs*. *Context* boxes now support fenced code blocks with syntax highlighting. * CloudCannon now automatically adjusts heading levels in the *Site Dashboard README* and *Context* boxes to fit correctly within the page hierarchy. * Improved the heading hierarchy across the app for better accessibility and screen reader support. * Updated the typography scale so all six heading levels (`h1`–`h6`) are properly styled and visually distinct. +* Added better error messaging when you try to open an incompatible file in the *Content Editor* or *Data Editor* (e.g., `.astro` or `.html`). +* Added a warning to the *Collection Browser* if some of your files require you to configure visual editing. +* Improved the *Collection* suggestions in the *Create a Configuration File* modal for folders with numerical folder names (e.g., `/changelog/2026/`). CloudCannon will now suggest the parent folder. * Redesigned the welcome screen for new *Organizations*. When you have no *Sites*, CloudCannon now presents two options: try a demo site or connect your own repository. +* Updated the functionality and appearance for the *Create a Site* page and the *Syncing* page under *Site Settings* with regards to authorizing your *Git Provider*. +* CloudCannon will now prompt you to configure installations if you don't have any after authorizing your *Git Provider*. +* Improved page load performance for *Sites* with *Authentication* enabled. ## Fixes -* Fixed an issue where... -* Updated dependencies to patch security vulnerabilities. -*   \ No newline at end of file +* Fixed an issue where the *Delete Organization* button on the *Delete* page under *Org Settings* was incorrectly enabled when you were not on a Personal Plan. +* Fixed an issue causing *Bandwidth* graphs on the *Organization Home* page and *Site Dashboard* to resize incorrectly. +* Fixed an issue causing screenshots to fail to load in the *Collection Browser*. +* Fixed an issue where *Component Editable Regions* would sometimes briefly show an error message immediately after the load. +* Fixed an issue where, in some cases, *Component Editable Regions* would not update the tagname of child *Editable Regions*. +* Fixed an issue where *Context Menus* for *Editable Regions* could be cutoff by elements with overflow styles. +* Fixed an issue where strings in MDX snippets would be incorrectly escaped. +* Updated dependencies to patch security vulnerabilities. \ No newline at end of file From f10380dfdbb5b56bf9220f4b2734a807156f6bc3 Mon Sep 17 00:00:00 2001 From: Ella Date: Thu, 5 Mar 2026 03:43:32 +0000 Subject: [PATCH 9/9] update copy --- changelogs/2026/03-05_site-dashboard-readme.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelogs/2026/03-05_site-dashboard-readme.mdx b/changelogs/2026/03-05_site-dashboard-readme.mdx index dbde23281..8c46b2715 100755 --- a/changelogs/2026/03-05_site-dashboard-readme.mdx +++ b/changelogs/2026/03-05_site-dashboard-readme.mdx @@ -5,7 +5,7 @@ date: 2026-03-05T08:41:01+13:00 --- This release added the *Site Dashboard* README file, redesigned the welcome screen for new *Organizations*, improved Markdown rendering in *Context* boxes, and updated the heading hierarchy across the app for better accessibility. -It also addressed several issues, including those affecting... +It also addressed several issues, including those affecting the *Delete Organization* button*, Bandwidth* graphs, screenshots in the *Collection Browser*, and *Editable Regions*. ## Features & Improvements