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

Make documentation/settings more discoverable #4288

Open
kaddkaka opened this issue Sep 13, 2023 · 1 comment
Open

Make documentation/settings more discoverable #4288

kaddkaka opened this issue Sep 13, 2023 · 1 comment
Labels
docs Primarily or only affects documentation

Comments

@kaddkaka
Copy link

What page or section of the docs have an issue?
Is it possible to add tags or hidden text to the documentation to make it easier to find specific pages? Took me 5 searches to find https://wezfurlong.org/wezterm/config/lua/config/selection_word_boundary.html?h=word even though I knew it existed.

Reasons:

  1. The title "selection_word_boundary" was not included in search match
  2. "boundary" doesn't match "boundaries" (stupid english)
  3. delimiter was not used in the description
@kaddkaka kaddkaka added the docs Primarily or only affects documentation label Sep 13, 2023
@wez
Copy link
Owner

wez commented Sep 13, 2023

While we're waiting for this upstream issue:

You can add tags, see https://raw.githubusercontent.com/wez/wezterm/main/docs/config/lua/config/adjust_window_size_when_changing_font_size.md for an example. Tags show up at the top of doc pages and link to a tag index: https://wezfurlong.org/wezterm/tags.html#font

Please feel empowered to submit PRs to various doc pages to add tags, preferably in alignment with existing tags
You can test doc changes locally by running ci/build-docs.sh serve

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Primarily or only affects documentation
Projects
None yet
Development

No branches or pull requests

2 participants