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

[REQUEST] Improve :doc searchability #5273

Open
Supreeeme opened this issue Jan 15, 2025 · 1 comment
Open

[REQUEST] Improve :doc searchability #5273

Supreeeme opened this issue Jan 15, 2025 · 1 comment

Comments

@Supreeeme
Copy link

Feature

Kakoune's built in docs are helpful, however I find they are not particularly discoverable if you don't actually know what category to search for.
For example, in setting up kakoune-lsp, you add this line to your config:

eval %sh{kak-lsp}

Seeing this for the first time, I was curious how %shworks. Doing a :doc sh or :doc %sh gives me nothing. Doing :doc eval takes me to doc-execeval which makes no mention of %sh. I had to actually peruse random docs to discover it's described under :doc expansions, which was really unclear to me. I imagine myself and others new to Kakoune will end up running into more things like that. I think it would be useful if at least one of two things could happen here:

  • Allow searching through all docs, similar to vim's :helpgrep. Maybe :docgrep?
  • Increase the number of things considered as "topics" for :doc

I think both of these would be useful, but I imagine something like :docgrep would be easier to immediately implement.

Usecase

No response

@Supreeeme
Copy link
Author

Immediately after writing this issue I discovered :doc expansions sh will jump right to the %sh section of the expansions doc. This still requires you to know the docs for %sh live in the docs for expansions, but maybe this can be leveraged somehow?

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

No branches or pull requests

1 participant