Skip to content

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

Open
@stargazer33

Description

@stargazer33

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions