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

cmd/cue: have a single source of truth for cli docs #9

Open
cueckoo opened this issue Jul 3, 2021 · 2 comments
Open

cmd/cue: have a single source of truth for cli docs #9

cueckoo opened this issue Jul 3, 2021 · 2 comments
Labels
Documentation FeatureRequest New feature or request roadmap/cli Specific tag for roadmap issue #337

Comments

@cueckoo
Copy link
Collaborator

cueckoo commented Jul 3, 2021

Originally opened by @mpvl in cuelang/cue#9

This likely means that the cli docs should be generated from the tool code.

@mvdan
Copy link
Member

mvdan commented Jun 13, 2023

My 2c: I think we should start moving towards all canonical documentation being on the website. Go already started doing this with https://go.dev/ref/mod, for example. Then go help modules is a short summary with HTTP links, rather than dozens of pages printed out to the terminal, which overwhelm almost anyone.

I also feel like markdown-like styling is helpful. Headers, links, code blocks, and so on. That is technically possible on the terminal with something like man pages, but I think web pages are generally more accessible to the majority of users, particularly when there is so much information.

We could and should keep cue help, but its contents should be limited in size and complexity. Packagers or distros could always ship the HTML pages alongside cmd/cue so that all the docs are available offline.

@mvdan mvdan removed the good first issue Good for newcomers label Oct 21, 2023
@jpluscplusm
Copy link
Collaborator

Adjacent to this issue, https://alpha.cuelang.org/docs/reference/cli/ is now available.

@mvdan mvdan removed the zGarden label Feb 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation FeatureRequest New feature or request roadmap/cli Specific tag for roadmap issue #337
Projects
None yet
Development

No branches or pull requests

4 participants