thegrumpys / odop

Open Design Optimization Platform (ODOP) - Coil spring design app; mechanical springs; compression spring, extension spring, torsion spring
https://www.springdesignsoftware.org
MIT License
4 stars 5 forks source link

Optimize Help docs for indexing w/ Lunr #677

Closed grumpyinca closed 2 years ago

grumpyinca commented 2 years ago

Titles (top level headings) with multiple "#" have already been converted to single "# ".

Section headers (second level headings) should be converted from bold to "## ".

"On this page" entries should be unstructured list (start with "-") and have no more than one trailing blank.

Index files should get brief introductory text.


Create Help topic that describes how to use the "Help lookup" feature. Syntax for forming a multi-word search string that is AND, not OR. Syntax to restrict search to doc titles only. Syntax to get a "fuzzy" search. This topic will be the target of the context help button at the bottom of the modal that presents full-text search results.

1fifoto commented 2 years ago

Merged into master, clsoing