-
Notifications
You must be signed in to change notification settings - Fork 788
Docs/cli #1365
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs/cli #1365
Conversation
✅ Deploy Preview for tauri-docs-starlight ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Continuing the conversation from #1363 ...
Awesome, thank you! <3
Maybe this is an upstream question... but why do we have
I think I prefer the current, non-table format. We can work on adjusting the formatting (because right now it's a ton of code blocks and inline code which can be tough to glance through), but I think this is a really solid foundation. Two more points:
Thanks for being amazing @FabianLars <3 |
Also, in addition to the table I mentioned, I think a quick tabbed code block of how to install the CLI would be amazing up at the top. |
One final thing: upstream is working on some fancy stuff that we can do in code blocks, so that might help the walls of code blocks be a bit more formatted once it's in: withastro/starlight#461 (comment) (I really should just let my replies sit for a few minutes before I hit comment so I don't post back to back replies 😅 ) |
Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
Notes that I'll open a tracking issue upstream for:
If/when those are resolved then we can come back and revise this. Does everything else look alright to a second pair of eyes? |
Do we want to make all section use tabs for commands in this pr or later when #1366 is resolved? otherwise looks good ig |
Ahh good point, I read that but missed it on the current pass. That component should be super simple to make so it might be better to just whip it up and do it right the first time. |
Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
Closes #1366 |
Looks good now, going to merge it in 💪 |
* init cli ref doc * copy paste a bit text stuff from v1 docs * split out plugins commands Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * re-order some stuff Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * fix help command Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * fix light mode table color Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * fix cargo install Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * add CommandTabs component Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * fix pnpm Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * commands --------- Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> Co-authored-by: FabianLars <fabianlars@fabianlars.de>
* init cli ref doc * copy paste a bit text stuff from v1 docs * split out plugins commands Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * re-order some stuff Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * fix help command Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * fix light mode table color Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * fix cargo install Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * add CommandTabs component Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * fix pnpm Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * commands --------- Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> Co-authored-by: FabianLars <fabianlars@fabianlars.de>
* init cli ref doc * copy paste a bit text stuff from v1 docs * split out plugins commands Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * re-order some stuff Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * fix help command Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * fix light mode table color Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * fix cargo install Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * add CommandTabs component Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * fix pnpm Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * commands --------- Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> Co-authored-by: FabianLars <fabianlars@fabianlars.de>
* init cli ref doc * copy paste a bit text stuff from v1 docs * split out plugins commands Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * re-order some stuff Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * fix help command Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * fix light mode table color Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * fix cargo install Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * add CommandTabs component Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * fix pnpm Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * commands --------- Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> Co-authored-by: FabianLars <fabianlars@fabianlars.de>
Just getting this into a draft PR for those fancy netlify previews
#1363