-
Notifications
You must be signed in to change notification settings - Fork 628
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
Fixed documentation generation in list-actions --docs
command
#4974
base: main
Are you sure you want to change the base?
Conversation
I'm not sure if there's any point to the helpful default message because the names of most of the undocumented actions document themselves (I doubt anyone would misinterpret |
54c0a17
to
71eabf5
Compare
ea6ef37
to
2ead606
Compare
I have readjusted the implementation, which mimics the current organization of the Action Reference documentation, putting related operation items together, like this:
|
list-actions --docs
command
2ead606
to
2e784cf
Compare
Previously, `ghostty +list-actions` would only show actions that had doc comments, making it difficult for users to discover all available actions. This change ensures all actions are listed with appropriate documentation. For actions without doc comments, we now generate a default message encouraging contribution.
The issue was caused by the documentation generation logic not writing the final buffered content.
This commit fixes two issues with the `list-actions` command: 1. Ensures all actions are listed, including those without individual documentation but sharing docs with related actions 2. Improves documentation formatting with proper indentation and grouping
2e784cf
to
0016199
Compare
Fixes #4958
Changes
Fixed documentation generation in
actions.mdx
:Fixed an issue where the last action's documentation was not properly generated
Ensured all actions' documentation is correctly included in the output
Improved
ghostty +list-actions --docs
command output formatting:Grouped related actions together with shared documentation
Added proper spacing between action groups
ghostty-dev +list-actions --docs
Testing
Run
ghostty-dev +list-actions --docs
to verify the new output formatCheck generated zig-out/share/ghostty/webdata/actions.mdx to ensure all actions are properly documented