Skip to content

docs: 📝 beautify command output in docs#319

Merged
lwjohnst86 merged 4 commits into
mainfrom
docs/format-cli-output-in-docs
May 18, 2026
Merged

docs: 📝 beautify command output in docs#319
lwjohnst86 merged 4 commits into
mainfrom
docs/format-cli-output-in-docs

Conversation

@joelostblom
Copy link
Copy Markdown
Contributor

@joelostblom joelostblom commented Apr 30, 2026

Description

Closes #193. See description and examples in the corresponding cdp PR seedcase-project/check-datapackage#342

Needs a thorough review.

Checklist

  • Ran just run-all

signekb
signekb previously requested changes May 5, 2026
Copy link
Copy Markdown
Member

@signekb signekb left a comment

Choose a reason for hiding this comment

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

Ooo, this is very nice and a huge improvement 👌 🎉
Two things:

  1. I think that the contrast between the light theme of the website and the dark of the terminal output is a bit harsh. My preference would be to have a lighter theme for the terminal as well, but I guess you and @lwjohnst86 decided on this theme in Soil?
  2. In the output below, can we show the files inside the resources/ folder as well?
image

@github-project-automation github-project-automation Bot moved this from In Review to In Progress in Product development May 5, 2026
@joelostblom
Copy link
Copy Markdown
Contributor Author

joelostblom commented May 6, 2026

Thank you! 😊

  1. I don't think we decided anything formally. I made a case in docs: 💄 beautify CLI output in docs check-datapackage#342 for that the default light/white background in the second screenshot there makes it hard to distinguish where the output starts and ends from the rest of the text.

    I also thought it would be nice to have some indication of what is output from a CLI command versus from Python code, but it is technically not necessary. We could still achieve that with the use of other dark colors too of course, I just modeled this of the colors that flower use in the terminal so that the docs look the same as the local experience (not necessary), which in turn are modeled after what I arbitrarily think looks good in the terminal =) We can totally change it, but maybe that happens in a follow up PR that since it might be a bigger change that also involves changes the default flower colors in terminal and the cdp docs?

  2. Yup, totally! Here or in a follow up PR after your change in feat: ✨ add file_tree() seedcase-soil#39 that adds the file tree viewer?

@joelostblom joelostblom requested a review from signekb May 6, 2026 05:58
@joelostblom joelostblom moved this from In Progress to In Review in Product development May 6, 2026
Copy link
Copy Markdown
Member

@lwjohnst86 lwjohnst86 left a comment

Choose a reason for hiding this comment

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

Nice 😁

@lwjohnst86 lwjohnst86 merged commit cca83c8 into main May 18, 2026
6 checks passed
@lwjohnst86 lwjohnst86 deleted the docs/format-cli-output-in-docs branch May 18, 2026 09:11
@github-project-automation github-project-automation Bot moved this from In Review to Done in Product development May 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Make prettier output in docs

3 participants