Skip to content

Conversation

@dwilding
Copy link
Contributor

@dwilding dwilding commented Oct 14, 2025

This PR adds a how-to guide for rendering CSV data as tables. It covers the included csv-table directive and the non-included Sphinx DataTables extension.

Preview doc

@dwilding
Copy link
Contributor Author

@AnneCYH I've started drafting the how-to guide for data tables. Want to get your input on something... On the how-to guides landing page (preview), I'm putting the new guide under "Optional features and workflows". However, this guide also covers non-interactive data tables, which are supported by default in the starter pack. I'm not totally satisfied with this approach - what's your opinion?

@AnneCYH
Copy link
Contributor

AnneCYH commented Oct 16, 2025

Hi @dwilding , I agree it isn't entirely accurate.
I do think it should still be kept separate from the typical features used in the starter pack projects.

I would suggest rewording the description for that section instead to be clear that some are already ready to use by default.


Additional features and workflows

As your documentation grows, you may need more advanced features to support richer content. This can include diagrams as code, automated API references, and data tables.

While some of these features are available by default in the starter pack, others may require additional extensions. The following guides will help you get started:

  • Create diagrams as code using Mermaid
  • Create data tables

@dwilding dwilding marked this pull request as ready for review October 20, 2025 05:31
@dwilding dwilding requested a review from AnneCYH October 20, 2025 05:32
@dwilding
Copy link
Contributor Author

Thanks @AnneCYH, I like your suggestion! I've updated this PR to use that wording.

Copy link
Contributor

@medubelko medubelko left a comment

Choose a reason for hiding this comment

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

LGTM. A few minor suggestions but nothing blocking.

Copy link
Collaborator

@minaelee minaelee 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 this!

Copy link
Contributor

@AnneCYH AnneCYH left a comment

Choose a reason for hiding this comment

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

Hey @dwilding , this looks good!

Just the typo (mentioned by @minaelee ) and also fixing the merge conflict for the index file.

Thanks for this!

@dwilding
Copy link
Contributor Author

Thanks @minaelee, @medubelko, @AnneCYH! I've made updates from all feedback. This is ready to merge after a tick from Minae

@AnneCYH AnneCYH requested a review from minaelee October 22, 2025 05:20
Copy link
Collaborator

@minaelee minaelee left a comment

Choose a reason for hiding this comment

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

Ty!

@dwilding dwilding merged commit 4084957 into canonical:main Oct 22, 2025
7 checks passed
@dwilding dwilding deleted the datatables-guide branch October 22, 2025 05:34
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.

4 participants