search

opengeospatial / CoverageJSON

Public repo for CoverageJSON project
Apache License 2.0
11 stars 8 forks source link

Added UML diagram and other minor edits #148

Closed jonblower closed 1 year ago

jonblower commented 1 year ago

Added the UML conceptual diagram as per #21.

On reflection, and slightly different to what we agreed in the telecon, I thought it was worth keeping "Illustrative Example" as a heading at the same level as the UML diagram, so we should end up with:

Introduction
 - Illustrative Example
 - UML diagram

which seems to make sense to me from the point of view of someone browsing the TOC. So this would effectively cancel out the previous PR. Does that make sense to you, @chris-little?

jonblower commented 1 year ago

Apologies for the conflicts - I should probably have cancelled the previous PR first, or based this PR on the current master branch

jonblower commented 1 year ago

The intention was actually to keep the "Illustrative Example" heading as I thought this looked logical as a sub-heading in parallel with the UML diagram. I think it helps people browsing the TOC, otherwise the "Introduction" section is quite long. I don't feel strongly though if you think otherwise.

chris-little commented 1 year ago

@jonblower apologies - I thought the conflict was the original Example title. Happy to put in again