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

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

Open
wu-lee opened this issue Feb 24, 2023 · 0 comments

Comments

@wu-lee
Copy link
Contributor

wu-lee commented Feb 24, 2023

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:

  • what the core fields are (which every map has)
  • how to find out what the custom fields are

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.

@wu-lee wu-lee changed the title Update the documentation for Mykomap's searchableFields config paramter Update the documentation for Mykomap's config paramter for searchableFields and other field-related parameters Feb 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant