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

docs: add autogenerated cli actions docs #253

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

anund
Copy link

@anund anund commented Jan 3, 2025

Add docs coverage for cli actions. Document is built using automation in the main ghostty repo. Content involved and location are a best guess given the current structure.

Edit on Github pointing at a folder (with an new accompanying README.md) is a compromise to avoid scoping in per item edit on github links.

The command used to copy the commands.mdx file for reference:

zig build -Demit-webdata=true && cp ~/src/ghostty-org/ghostty/zig-out/share/ghostty/webdata/commands.mdx ~/src/ghostty-org/website/docs/features/commands.mdx

See ghostty-org/ghostty#4499 for generation code.

Copy link

vercel bot commented Jan 3, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
website ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 8, 2025 6:46am

@anund
Copy link
Author

anund commented Jan 8, 2025

Updated to export to match 1.0.1 version help text. To do this I cherry picked a compatible commit back to the v1.0.1 tag and reran generation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants