Skip to content

Readability improvements to README#14

Open
kylebarron wants to merge 1 commit intozarr-conventions:mainfrom
kylebarron:kyle/readme-edits
Open

Readability improvements to README#14
kylebarron wants to merge 1 commit intozarr-conventions:mainfrom
kylebarron:kyle/readme-edits

Conversation

@kylebarron
Copy link
Copy Markdown

@kylebarron kylebarron commented Apr 7, 2026

Changes

  • Refer to the "proj" convention by its proper name geo-proj, not proj:. proj: is the key prefix and geo-proj seems to be the proper name of the convention
  • More hyperlinks. There should be easy links to the geo-proj and multiscales conventions when we reference them.
  • Move field attributes from h4 to h3 to make their definitions more prominent
  • Change several "bolded headers" to "h4 headers". This is important because it gives an explicit anchor to these headers. So a consumer can link directly to "coordinate convention", for example
  • Move the section about "implications of using spatial:transform with multiscales" as part of the definition of spatial:transform, not the example section.

## Properties

All properties use the `spatial:` namespace prefix and are placed at the root `attributes` level.
All properties use the `spatial:` namespace prefix and are placed at the root `attributes` level (except for **`spatial:transform`**, which must be placed inside the `layout` array when composed with [`multiscales`]).
Copy link
Copy Markdown
Author

@kylebarron kylebarron Apr 7, 2026

Choose a reason for hiding this comment

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

oops this slipped in from #15

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.

1 participant