[openstreetmap/openstreetmap-website] Minor changes to docs (PR #5319)

Andy Allan notifications at github.com
Wed Nov 13 17:27:23 UTC 2024


This PR combines a few minor changes to the docs that I noticed while working on #5318 

* Add missing top-level headers to two files
* Standardise on fenced code blocks in markdown, for consistency and to allow language declarations
* Use language declarations for yaml code blocks

I also considered adding language information for code intended to be typed at the console, but then that turns out to be more complex with a choice of declarations (e.g. `bash` vs `console`) and whether to add `$ ` as a guide that it should be typed, and what to do with things that start with a console command but is then mainly `irb` from that point on, so I'll leave all that for some other time.
You can view, comment on, or merge this pull request online at:

  https://github.com/openstreetmap/openstreetmap-website/pull/5319

-- Commit Summary --

  * Use fenced code blocks
  * Add missing headers to docs
  * Add yaml syntax highlighting to code blocks

-- File Changes --

    M CONFIGURE.md (4)
    M CONTRIBUTING.md (2)
    M DOCKER.md (100)
    M FAQ.md (2)

-- Patch Links --

https://github.com/openstreetmap/openstreetmap-website/pull/5319.patch
https://github.com/openstreetmap/openstreetmap-website/pull/5319.diff

-- 
Reply to this email directly or view it on GitHub:
https://github.com/openstreetmap/openstreetmap-website/pull/5319
You are receiving this because you are subscribed to this thread.

Message ID: <openstreetmap/openstreetmap-website/pull/5319 at github.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstreetmap.org/pipermail/rails-dev/attachments/20241113/999da06d/attachment.htm>


More information about the rails-dev mailing list