mbox series

[layerindex-web,00/10] Documentation updates; README files as Markdown

Message ID 20261018220308.72731-1-tim.orling@konsulko.com
Headers show
Series Documentation updates; README files as Markdown | expand

Message

Tim Orling Oct. 18, 2026, 10:02 p.m. UTC 
This series applies on top of the "Docker: environment files" and
"dockersetup.py" series, which patches 2 and 9 document.

Patches 1-4 update the content: running the tests and the current
requirements in README.devel, upgrading to the environment files and
the new settings in README, ENABLE_RRS in README.rrs, and removing the
obsolete docker/README.

Patches 5-7 convert the README files to Markdown in three steps to keep
the history readable: a pure rename, the updated references to the
files, and a formatting-only change that leaves the wording alone.

Patches 8-10 correct the REST API note (the API is enabled and
read-only, not disabled), fix a JSON example and a typo, use
"docker compose" in the examples, and show the git configuration for
sending patches to this list.

Tim Orling (10):
  README.devel: document running the tests; update requirements
  README: document upgrading to env files and the new settings
  README.rrs: mention ENABLE_RRS for the Docker-based setup
  docker/README: remove
  Rename the README files to .md
  Update references to the renamed README files
  Format the README files as Markdown
  README.md: fix the REST API note, a JSON example and a typo
  README.md: use "docker compose"
  README.md: show how to configure git for sending patches

 COPYING.MIT                 |   2 +-
 Dockerfile                  |   2 +-
 README.devel                | 159 --------------
 README.devel.md             | 228 ++++++++++++++++++++
 README => README.md         | 417 ++++++++++++++++++++----------------
 README.rrs => README.rrs.md |  48 +++--
 README.vscode               |  50 -----
 README.vscode.md            |  49 +++++
 SECURITY.md                 |   2 +-
 docker/README               |  52 -----
 10 files changed, 544 insertions(+), 465 deletions(-)
 delete mode 100644 README.devel
 create mode 100644 README.devel.md
 rename README => README.md (50%)
 rename README.rrs => README.rrs.md (53%)
 delete mode 100644 README.vscode
 create mode 100644 README.vscode.md
 delete mode 100644 docker/README


base-commit: e6040597ae0f614581de241fe78f20e34dae13ac
prerequisite-patch-id: 0cfb656e605b0ec4a84298986850c958648f94bf
prerequisite-patch-id: cf25fa25d9d94e47af321358b41c451717173512
prerequisite-patch-id: a3d6bb81b18633b51f922cc20a99b84ac423393b
prerequisite-patch-id: e1c00c40927a7db84488f2ce1b4ed40f3aa14aa0
prerequisite-patch-id: f957afb8dce214b3974e5c8c5924da1f7ba45ea4
prerequisite-patch-id: e67a8b6db7218cda1936f1b5d4eb9a9cad4c2dd0
prerequisite-patch-id: 6876328ca001cfedf7a4c9695dee294b40028ba6