SearchKit documentation overhaul - Manchester Sprint
Tracking items to improve Searchkit documentation. In general, documentation should be written for the non-technical user audience.
-
Revise introduction to describe more of what SK is and what it can do, de-emphasize its history (demote to a different level in the docs). -
Intro 'for dummies'
-
-
How to create searches - basic walk-through tutorials. -
The search screens -
displays -
forms
-
-
Reword existing examples -
Create an Advanced Settings page that explains the different components of SK and that defines each part of the Search form its impact / functionality. Provide greater instruction on other aspects such as display options. -
Format: Numbered lists, bullet points to have new line for each new point (less dense chunks of text) -
'relative date formats' section: The explanation of the list should come before the list. I was a bit confused about the 'ending' prefix on first read through because I didn't immediately realise it related to the list. The examples of date are useful but think it would be more 'viewable' if each new one was in a line, i.e. 3 days... 3 weeks... 3 months.. -
Revise (again) to use SearchKit instead of Searchkit everywhere -
Change all forms of form builder to FormBuilder everywhere