DigitalCommons / mykomap

A web application for mapping initiatives in the Solidarity Economy
3 stars 0 forks source link

Update the documentation for Mykomap's config paramter for `searchableFields` and other field-related parameters #184

Open wu-lee opened 1 year ago

wu-lee commented 1 year ago

Mm Version: 3.0.2+

The current documentation for this (and some other) config parameters doesn't explain what the fields used in the value can be, or how to find that out. We need to explain:

Currently the latter isn't obtainable in a very user-friendly way, as the main source of information is in the config.ts file (or the published config.json file, which at least is possible to inspect via ShipShape; although again that's not super simple as it requires clicking on the right link and interpreting some JSON).

So, in the first instance, we can just explain for developers and technical people; for end users, there may need to be some new features requested.