2025 Documentation Redesign

Thanks Gio!

Funnily enough, we’ve already committed to using Divio/Diataxis for our documentation content. You may have noticed an increase in “What is…” articles and key Reference articles. This is in direct response to Diataxis revealing holes in our documentation. I’m glad we’re on the same page. :party_popper:

The 2025 Documentation Redesign is more about the UX/UI of our documentation pages. But I’m always open to feedback about pages or concepts where you think the content needs work. The Documentation Feedback category in this community is a great place to post (I’ll be in here every day :eyes:).

On your comment about template strings :thread:

You’re right — the template string docs need work. I’ll make a ticket improve the clarity of the language we use there.

In the two examples you give, values: data.listings.filtering[*] is a JSONPath selector while hidden: '!enable_banner' is an expression.

  • hidden key reference here
  • values key reference here

The hidden key for Inputs accepts both boolean and string values. This key is an example of our early implementation of CloudCannon’s expression engine, and we’ll probably update it in the future.

We recently started supporting JSONPath selectors ([*]) for strings (data.listings.filtering) in the values key (here’s a changelog) rather than the single level references (e.g. collections.posts or data.listings ). This allows you to dig deeper, and filter into these datasets. We touch on this concept in the Filters section of our Select Input article, but this feature is not well documented yet :folded_hands:

I want to make better Reference documentation :flexed_biceps:

I’m committed to making more docs like our key Reference pages so that this kind of information never comes as a surprise to the user. The docs should describe the following for every configuration key:

  • The key name
  • The key definition
  • Where and how you should use a key in your CloudCannon configuration file
  • Links to relevant parent keys and subkeys
  • Valid values for a key
  • Real examples of how to use that key

In the 2025 Redesign, I want to give key Reference pages their own home (I talk about that in this thread) so it’s easier to search for configuration examples. If you have any thoughts about that, I’d love to hear them!

6 Likes