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

[low prio] add some end-user documentation (or documentation "building blocks") #31

Open
stargazer33 opened this issue Apr 12, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@stargazer33
Copy link

uFuzzy has some non-obvious features like

  • partial match
  • how to exclude words from search
  • "requires first char to match"
  • ...

Now imagine uFuzzy used on some website. Somehow end-users should know about all these things.
So, developer starts to write documentation describing search functionality.
It would be great if a template of end-user documentation would be avaliable.

Yes, there are many ways to configure uFuzzy, so I can imagine a list of "documentation building blocks":

intraMode: 0 -- use this text
intraMode: 1 -- use this text
intraIns: 0 -- use this...
intraIns: 1 -- use that...

Again, this is a very low priority thing

@howesteve
Copy link

Yes please :)

@LoganGrasby
Copy link

This would be great :)

@leeoniya leeoniya added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants