:thread: <@U07R6DNLS0N> <@U05GAUSPMU5> <@U081SSQJD...
# atmos-dev
e
🧵 @Vinny @Samuel Than @Andrey Kalmykov re: command examples.
👀 1
The examples for a command are arguably the most important as that shows users how to use it without needing to read the details
We already support an Example section from Cobra
I would like to format examples like in the Vercel CLI.
One option is that we use glow to render the examples section as markdown. Not sure if that is a good or bad idea. @Vinny
This is what I would like to do:
Also, I want the command help to always end with a link to the public docs for that command
If we use markdown formatting, then the theme colors are already handled for us .
Since @Shubham Tholiya has done the most work with cobra, I am tagging you.
Since @Vinny has done the most work with charm libs, including glow, I am tagging you on how we approach formatting
Since @Andrey Kalmykov is implementing a new atmos docs command, I am tagging you. I suggested a code change in your PR that broke it. My code change was to use the markdown formatting :)
Another idea to consider: if we move examples to a markdown file and use go:embed, we can use the same file in our web docs using MDX to include it. Then we don’t need to repeat it.
v
Thats my recomendation as well, I was expecting for us to move all examples to markdown and use the embed approach
👍 1
a
Guys, thanks, understood that the plan is to move to the embed examples. @Vinny Please let me know when it is ready and there's a sample on how to properly embed them. @Erik Osterman (Cloud Posse) if no bjections, for now and as a temp solution, have switched the examples to as before state (no back ticks)
👍 1
e
That’s fine
s
Yep makes sense. Markdown it is 🚀