Changelog March 5 2026

.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

_data/docshots.yml

@@ -1 +1 @@
-source: main_d67e3d9186386148d8317261eba1bdd9bab5a306
+source: main_2ab0643138babde9ecc9a004109593b4b4d11f87

_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:

changelogs/2026/03-05_site-dashboard-readme.mdx

@@ -0,0 +1,34 @@
+---
+_schema: default
+title: Site Dashboard README
+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 the *Delete Organization* button*, Bandwidth* graphs, screenshots in the *Collection Browser*, and *Editable Regions*.
+
+## 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.
+* 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 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.

developer/articles/add-a-site-dashboard-readme.mdx

@@ -0,0 +1,59 @@
+---
+_schema: default
+_uuid: bf4cc23c-8aae-46fc-9a4c-ad786a061811
+_created_at: 2026-03-05T00:00:00Z
+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 <comp.GlossaryTerm term="/user/glossary/c/configuration-mode.yml">Configuration Mode</comp.GlossaryTerm>, or by creating the file directly in your <comp.GlossaryTerm term="/user/glossary/i/ide.yml">Local Development Environment</comp.GlossaryTerm>.
+
+## 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 <comp.GlossaryTerm term="/user/glossary/c/content-editor.yml">Content Editor</comp.GlossaryTerm>.
+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*.
+
+<comp.DocShot docshot_key="CloudCannon-Documentation-Dashboard-No-README-Config-On" alt="A screenshot of the Site Dashboard with Configuration Mode on shows a purple + Add README button." title="The Site Dashboard" type="screenshot"/>
+
+## 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*.
+
+<comp.Notice info_type="info">
+  The file path is case-insensitive. CloudCannon recognizes `.cloudcannon/README.md`, `.cloudcannon/readme.md`, and other case variations.
+</comp.Notice>
+
+## Edit your README
+
+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.
+
+<comp.DocShot docshot_key="CloudCannon-Documentation-Dashboard-README-Config-On" alt="A screenshot of the Site Dashboard with Configuration Mode on shows a purple Edit README button." title="The Site Dashboard with README" type="screenshot"/>

developer/articles/what-is-the-site-dashboard-readme.mdx

@@ -0,0 +1,100 @@
+---
+_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 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:
+---
+You can add more context and instructions to your *Site* by adding a the `.cloudcannon/README.md` <comp.GlossaryTerm term="/user/glossary/m/markdown.yml">Markdown</comp.GlossaryTerm> file to your *Site*. When CloudCannon detects this file, it will render the contents on the *Summary* tab of your <comp.GlossaryTerm term="/user/glossary/s/site-dashboard.yml">Site Dashboard</comp.GlossaryTerm>.
+
+<comp.DocShot docshot_key="CloudCannon-Documentation-Dashboard-README-Config-Off" alt="A screenshot of the Site Dashboard shows custom Markdown content at the top of the Summary tab." title="The Site Dashboard with README" type="screenshot"/>
+
+## 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.
+
+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 [add a Site Dashboard README](/documentation/developer-articles/add-a-site-dashboard-readme/).
+
+## 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:
+
+<comp.CodeBlock language="Markdown" source=".cloudcannon/README.md">
+```
+## Heading
+
+Description:
+
+&#96;&#96;&#96;yaml
+title: My Site
+description: A great site
+&#96;&#96;&#96;
+```
+</comp.CodeBlock>
+
+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:
+
+<comp.CodeBlock language="Markdown" source=".cloudcannon/README.md">
+```
+## Quick links
+
+* [Edit the home page](cloudcannon:collections/pages/index.md)
+* [View all blog posts](cloudcannon:collections/posts)
+* [Site Settings](cloudcannon:settings)
+```
+</comp.CodeBlock>