docs: Cleanup and improve the actions documentation with arguments and examples #4446
+198
−103
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
erf
force-pushed
the
cleanup-action-docs-w-args
branch
4 times, most recently
from
d016d31 to
379e43b
Compare
- Add consistent format for action documentation - Standardize argument descriptions and example format - Add missing documentation actions descriptions - Make platform limitations explicit
erf
force-pushed
the
cleanup-action-docs-w-args
branch
from
379e43b to
13ad7b2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improve the documentation of actions generated from
Binding.zigto make it more clear and consistent.Key improvements:
keybind = key=action:valuesyntaxRelated to this discussion.
Note: The documentation was improved with the help of AI (Claude and Copilot)