Skip to content

Conversation

@asanvaq
Copy link
Contributor

@asanvaq asanvaq commented Dec 3, 2025

ROCKS-2627
A new model is implemented for the Chisel docs homepage based on the template for 26.04. This includes:

  • An updated introduction section to mention what the product is, what the product does, what need the product meets and whom the product is useful for.
  • A new "In this documentation" section that systematically exposes the documentation’s contents.
  • An updated "How this documentation is organized" section that sets expectations for the reader.
  • An updated "Project and Community" section with some information added.

@asanvaq asanvaq marked this pull request as ready for review December 4, 2025 11:00
@asanvaq asanvaq requested a review from cjdcordeiro December 4, 2025 11:00
Copy link
Collaborator

@cjdcordeiro cjdcordeiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the changes, almost there

asanvaq and others added 5 commits December 10, 2025 14:13
Co-authored-by: Cristovao Cordeiro <cristovao.cordeiro@canonical.com>
Signed-off-by: Anna Sancho Vaquer <anna.sanchovaquer@canonical.com>
Signed-off-by: Anna Sancho Vaquer <anna.sanchovaquer@canonical.com>
Co-authored-by: Cristovao Cordeiro <cristovao.cordeiro@canonical.com>
Signed-off-by: Anna Sancho Vaquer <anna.sanchovaquer@canonical.com>
Signed-off-by: Anna Sancho Vaquer <anna.sanchovaquer@canonical.com>
Signed-off-by: Anna Sancho Vaquer <anna.sanchovaquer@canonical.com>
Copy link
Collaborator

@cjdcordeiro cjdcordeiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much for all the back and forth. It turned out quite well, and I'm leaving a couple of non-blocking comments for us to follow up on ;)

compact, secure software.

Developers need to be able to create software suited to their specific needs with a reduced attack
Users need to be able to create software suited to their specific needs with a reduced attack
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I won't block the PR on this, cause it's quite nuanced, but just food for thought: in the line above, Chisel is depicted as a "developer tool". The conotation is different, which doesn't make the use of "Users" wrong here (IMO), but worth noting, just in case you have a different interpretation


---------

This documentation uses the [Diátaxis documentation structure](https://diataxis.fr/).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for being willing to try this out.

This looks good enough for now. But I'd like to find a better place for it still.

Just continue discussing the following on the side:

@cjdcordeiro cjdcordeiro merged commit 7499ed7 into canonical:main Dec 10, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants