Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Need generator for CLI reference page #1985

Closed
dklassic opened this issue Mar 21, 2024 · 5 comments · Fixed by #2535
Closed

Need generator for CLI reference page #1985

dklassic opened this issue Mar 21, 2024 · 5 comments · Fixed by #2535
Labels
enhancement Does it add or improve content?
Milestone
Version 2.0

Comments

@dklassic
Copy link
Contributor

dklassic commented Mar 21, 2024 •
edited
Loading

Need a generator for CLI reference pages to prevent missing commands. Currently CLI reference pages are static pages and will prone to error as Tauri updates.
@github-project-automation github-project-automation bot moved this to 🪵 Backlog in Documentation Mar 21, 2024
@dklassic dklassic mentioned this issue Mar 21, 2024
Merged
@vasfvitor
Copy link
Contributor

you mean the cli.mdx files in references? I just looked it at next and it seems they are not generate, am I missing something?

@FabianLars
Copy link
Member

Ah that's my bad then, I thought we still autogen it like in the old docs

@dklassic
Copy link
Contributor Author

dklassic commented Mar 22, 2024 •
edited
Loading

No wonder why I can't find the autogen scripts ~ _ ~

Should we still do it in the autogen way somehow or should we just manually change the pages with #1936 and call it a day?

@vasfvitor
Copy link
Contributor

This could be added to the plans yeah, right now the cli page is outdated, missing tauri permission commands and maybe more. For now I think it's good to just manually change

@dklassic dklassic changed the title Generator for CLI needs npm command fixing Need generator for CLI reference page Mar 22, 2024
@vasfvitor
Copy link
Contributor

vasfvitor commented Mar 25, 2024 •
edited
Loading

maybe clap markdown could be implemented upstream? But it doesn't seem to be maintained

@simonhyll simonhyll added this to the Version 2.x milestone May 3, 2024
@m-krebs m-krebs mentioned this issue May 16, 2024
Merged
@simonhyll simonhyll added enhancement Does it add or improve content? and removed tauri 2.0 docs labels May 21, 2024
@simonhyll simonhyll modified the milestones: Version 2.x, Version 2.0 May 23, 2024
@simonhyll simonhyll moved this from 🪵 Backlog to 💪 Ready in Documentation May 23, 2024
@vasfvitor vasfvitor linked a pull request Aug 11, 2024 that will close this issue
feat: autogenerate CLI command docs #2535
Merged
@github-project-automation github-project-automation bot moved this from 💪 Ready to ✅ Done in Documentation Aug 12, 2024
@FabianLars FabianLars moved this from ✅ Done to 💪 Ready in Documentation Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Does it add or improve content?
Projects
Documentation
Status: 💪 Ready
Milestone
Version 2.0
Development

Successfully merging a pull request may close this issue.

feat: autogenerate CLI command docs tauri-apps/tauri-docs
4 participants
@dklassic @FabianLars @vasfvitor @simonhyll