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

feat: sub item documentation for completion menus #12219

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

NikitaRevenco
Copy link
Contributor

Typed Commands show a little box containing information about the command:

image

Wouldn't it also be nice if sub-commands also contained information boxes? Currently, you don't get any documentation beyond the first command:

image

I added this ability. Now, you have documentation per-option directly within the editor:

image


I only added a few entries for documentation as this is a proof-of-concept. Some ideas to consider:

  • We could store the documentation in markdown and display it here. Since Helix can display Markdown, it would have code blocks, syntax highlighting and all
  • This is a bare implementation. Thoughts on this idea maintainers?
  • We could store all documentation this way and then extend cargo xtask to generate the website's documentation. I'm happy to port the current website's e.g. editor reference right into the editor. This is just one possibility.

Thoughts on this PR? I personally really wanted this feature because I think having documentation within the editor more accessible is always a good idea. Let me know in the comments

@gabydd
Copy link
Member

gabydd commented Dec 8, 2024

This is a nice idea one thing we probably want before this is #997 then we can add the config option documentation to in editor help as well

@NikitaRevenco NikitaRevenco marked this pull request as draft December 8, 2024 22:18
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