Some guideline for indexing terms
Problem or new feature
Whenever searching for a term, it's quite daunting to find different formatted versions of the same term: Lowercase vs uppercase, singular vs plural, term repeated several times w/o clear indication where each version leads to, etc.
Suggestions
I'm not sure if there's a guideline for indexing. If not, here are a few ideas:
-
Unless strictly necessary, keep terms as singular nouns ("methods" vs. "method").
-
Unless strictly necessary, keep terms in lowercase ("List" vs "list").
-
Add disambiguation for already existing indexes. I'm not sure if the disambiguation words/phrases should also be formatted in a particular way (e.g., lowercase, titlecase, etc.). That could be handled by the JS code responsible for the search functionality but it'd be better to have it directly in the Pod documents. For example:
array (basics) array (native types)
-
Before adding a new index, check if there's already something that covers for it. If there is, then use that one following the above steps.
This is mainly something that has been done in "legacy" style. But we do need some guidelines. Ideally, we should only index automatically. But then... There's even repeated index, and you can also create a category just by adding a word. Too many categories already: #1410.