Skip to content

[DOCS] De-indent remaining blocks and lint-clean SCHEMA_CONVENTIONS.md - #628

Open
Seth Fitzsimmons (sethfitz) wants to merge 4 commits into
mainfrom
docs/fix-schema-conventions-indented-blocks
Open

[DOCS] De-indent remaining blocks and lint-clean SCHEMA_CONVENTIONS.md#628
Seth Fitzsimmons (sethfitz) wants to merge 4 commits into
mainfrom
docs/fix-schema-conventions-indented-blocks

Conversation

@sethfitz

@sethfitz Seth Fitzsimmons (sethfitz) commented Jul 31, 2026

Copy link
Copy Markdown
Collaborator

Description

Follow-up to #597, which de-indented only the "Opening hours/validity Periods" paragraph. This applies the same treatment to every other indented block so it renders as prose instead of a code block, and adds a blank line between each section heading and its first paragraph.

Details

  • De-indented the Relations, Measurements, and Regulations paragraphs, the i.e. continuation under "The Basics", and the -insert example placeholder under "Extensions" — all previously rendered as code blocks on GitHub.
  • Normalized the remaining Markdown so the file is markdownlint/rumdl clean apart from line length (MD013), which is left as-is to avoid hard-wrapping prose: list-marker spacing (MD030), nested list indentation (MD007), and blank lines around headings and lists (MD022/MD032).
  • The boolean-property examples (has_street_lights=true, is_accessible=false) become a fenced code block, preserving their intended line breaks.

Fixes #627

ferkans-amir and others added 4 commits July 23, 2026 21:18
Signed-off-by: Victor Schappert <victor.schappert@protonmail.com>
…ONVENTIONS.md

Follow-up to #597, which de-indented only the Opening Hours paragraph.
Apply the same treatment to every other indented block so it renders as
prose instead of a code block, and add a blank line between each section
heading and its first paragraph:

- Relations, Measurements, and Regulations paragraphs
- the "i.e." continuation under The Basics
- the "-insert example" placeholder under Extensions

Also normalize the remaining Markdown so the file is rumdl/markdownlint
clean apart from line-length (MD013), which is left as-is to avoid
hard-wrapping prose:

- list-marker spacing (MD030) and nested list indentation (MD007)
- blank lines around headings and lists (MD022, MD032)
- the boolean-property examples become a fenced code block, preserving
  their intended line breaks

Signed-off-by: Seth Fitzsimmons <seth@mojodna.net>
@github-actions

Copy link
Copy Markdown

🗺️ Schema reference docs preview is live!

🌍 Preview https://staging.overturemaps.org/schema/pr/628/schema/index.html
🕐 Updated Jul 31, 2026 19:48 UTC
📝 Commit f6d227e
🔧 env SCHEMA_PREVIEW true

Note

♻️ This preview updates automatically with each push to this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

change type - documentation - member 📝 Documentation change by Overture member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] SCHEMA_CONVENTIONS.md: remaining indented blocks render as code and file is not lint-clean

4 participants