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: improve doc structure for action bindings with args and examples #5344

Merged
merged 4 commits into from
Jan 24, 2025

Conversation

erf
Copy link
Collaborator

@erf erf commented Jan 24, 2025

Related to #4446 , as suggested i've made a smaller chunk of updates for the action binding docs, including arguments and examples. I did this only for enum types this time.

I've also included the argument type name in the Argument (e.g. AdjustSelection).

Not sure if we should include the keybindings or not in the example?

I also added a format of some unrelated code change.

@erf erf force-pushed the cleanup-action-binding-docs branch from 8a45a82 to c4c2d06 Compare January 24, 2025 08:07
Copy link
Contributor

@mitchellh mitchellh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, much better 😄 One note.

src/input/Binding.zig Outdated Show resolved Hide resolved
@erf erf requested a review from mitchellh January 24, 2025 16:26
@mitchellh mitchellh enabled auto-merge January 24, 2025 23:33
@mitchellh mitchellh merged commit e2e6770 into ghostty-org:main Jan 24, 2025
30 checks passed
@github-actions github-actions bot added this to the 1.1.0 milestone Jan 24, 2025
@erf
Copy link
Collaborator Author

erf commented Jan 25, 2025

How does the website get updated?

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

Successfully merging this pull request may close these issues.

2 participants