Skip to content

Update the documentation for the category series - #4166

Open
Itz-Agasta wants to merge 5 commits into
osm-search:masterfrom
Itz-Agasta:docs-category-series
Open

Update the documentation for the category series#4166
Itz-Agasta wants to merge 5 commits into
osm-search:masterfrom
Itz-Agasta:docs-category-series

Conversation

@Itz-Agasta

Copy link
Copy Markdown
Contributor

Summary

Documentation follow-up for #4106, #4146, #4163, and #4164 as part of the GSoC period.

AI usage

After I was done, asked ai to review it against the codebase and check if I was missing anything....It made a few patches on its own.

Contributor guidelines (mandatory)

  • I have adhered to the coding style
  • I have tested the proposed changes
  • I have disclosed above any use of AI to generate code, documentation, or the pull request description

@Itz-Agasta
Itz-Agasta marked this pull request as draft August 14, 2026 07:33
Comment thread docs/api/Search.md Outdated
Comment thread docs/customize/Import-Styles.md Outdated
@mtmail

mtmail commented Aug 14, 2026

Copy link
Copy Markdown
Collaborator

Well caught that documentation for place_entrance and place_associated_street was missing so far.

@Itz-Agasta
Itz-Agasta force-pushed the docs-category-series branch from 5fd27f9 to 4739081 Compare August 14, 2026 09:18

@lonvia lonvia left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aaahhh, now we are really running into the ambiguity between the existing 'category' and the new 'categories'.

As there are already a lot of references to "main tag" when talking about the class/type columns, I would suggest that we stick to that name and drop all references to 'category' for that. So sooner or later we have the values in the category column as the only 'category'.

Also, can you please mark the 'categories' API parameter as deprecated. One of the next PRs should be to simply map it to include and some day it should go away completely (similar to Photon's osm_tag.)

Comment thread docs/api/Search.md Outdated
The place table holds a single row per OSM object now, with a categories
column that carries all of its main tags. Document that, the categories
column on placex and the tables that were added since the page was last
touched: place_entrance, placex_entrance, place_associated_street and
location_area_country. The place_classtype tables are gone, so drop them
from the list of auxiliary tables.

Also bring the diagrams back in line with the schema. search_name lost
its search_rank column a while ago and location_postcodes gained is_area,
while its centroid was missing from the diagram because of a typo.
An object with several main tags gets one database entry with a category
per tag now, instead of one entry per tag. Describe how a category is
built from a main tag and which of the main tags ends up as the class and
type of the place. Fallback tags always contribute a category now, they
only lose the race for class and type.
@Itz-Agasta
Itz-Agasta force-pushed the docs-category-series branch from 4739081 to 06ab0fc Compare August 20, 2026 03:59
@Itz-Agasta
Itz-Agasta marked this pull request as ready for review August 20, 2026 04:00
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

Successfully merging this pull request may close these issues.

3 participants