search

quicksilver / manual

Quicksilver Manual
3 stars 2 forks source link

Add information about adding symlink directories #11

Closed n8henrie closed 2 years ago

n8henrie commented 2 years ago

Fixes https://github.com/quicksilver/Quicksilver/issues/2758

pjrobertson commented 2 years ago

LGTM! I might try to cut down on the text, to keep it as short as possible. Otherwise people may end up overlooking it. Do you want to have a stab at shortening? If not, I'm happy to have a go.

n8henrie commented 2 years ago

Feel free -- IMO users will likely be searching for a specific issue in the FAQ (or more likely we will be directing them to it), so I don't see the risk of overlooking as a big problem; it probably should be overlooked unless people are running into this specific issue.

Which I guess makes it a not-so-frequently asked question. Perhaps this go somewhere else, like the troubleshooting section?

n8henrie commented 2 years ago

Also -- it would be nice to have automatic anchors generated for headers, to be able to link users to specific sections. It looks like we can enable this behavior with a TOC extension in mkdocs: https://www.mkdocs.org/user-guide/writing-your-docs/#linking-to-pages

Mind if I enable this?

pjrobertson commented 2 years ago

Which I guess makes it a not-so-frequently asked question. Perhaps this go somewhere else, like the troubleshooting section?

That maybe makes more sense. My hope is to make the docs as user-searchable/discoverable as possible. Search engines need to be able to index them easily as well. If you want to adjust the location, feel free to make the changes straight to master.