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.

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

Automatically generate quarto-web-ready documentation from Cliffy command descriptions #1531

Open
Tracked by #9093
cscheid opened this issue Jul 25, 2022 · 3 comments
Assignees
Labels
documentation Doc improvements & quarto-web enhancement New feature or request
Milestone

Comments

@cscheid
Copy link
Collaborator

cscheid commented Jul 25, 2022

It would be great to generate the automatically documentation for the CLI options on quarto-web. Ideally, we'd do it in the same way that we do the documentation for yaml options, by deferring to a single source of truth.

@cscheid cscheid added documentation Doc improvements & quarto-web enhancement New feature or request labels Jul 25, 2022
@cscheid cscheid self-assigned this Jul 25, 2022
@cscheid cscheid added this to the Future milestone Jul 25, 2022
@cderv
Copy link
Collaborator

cderv commented Feb 19, 2024

I completely missed this (old) issue ! We should definitely do this, I believe this would solve a bunch of issues we have around outdated CLI help.

@cscheid do you think we can do that for 1.5 ? Or still something we need to defer ?

@mcanouil
Copy link
Collaborator

FYI "EPIC":

@cderv
Copy link
Collaborator

cderv commented Feb 19, 2024

Thank @mcanouil. It was linked by @cwickham just above last week already, which made me aware of this issue.

It is now linked clearly in both direction 😄

@cwickham cwickham mentioned this issue Mar 15, 2024
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Doc improvements & quarto-web enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants