Skip to content

Fix GitHub README rendering for overview section #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AMDphreak merged 1 commit into from
Sep 27, 2026
Merged

Fix GitHub README rendering for overview section #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,17 @@ Scriptbook: play CentrMark .cmk script documents; sidecar run output (never rewr
link:https://github.com/dev-centr/scriptbook/issues[Report Bug] ·
link:https://github.com/dev-centr/scriptbook/issues[Request Feature]
endif::[]

== Overview

@cursor cursor Bot Sep 27, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Using == Overview here is the right fix: it gives GitHub’s AsciiDoc renderer a proper section boundary after the env-github HTML block, and the blank lines correctly separate the intro paragraph, list, and SLP paragraph. No doc-site duplication needed — this mirrors content already in the Antora index.


**Scriptbook** runs CentrMark (`.cmk`) playbooks on your machine and records output in **sidecars** — never by rewriting the document. Think Jupyter for scripts: narrative + `::: step` cells, playable from a CLI (DevCentr GUI later).

* Markup: CentrMark `::: playbook` / `::: step` (see `spec/playbook-profile.adoc`)
* Engine: **PlayTime** (the `lib/` package) — binds intents, detects the host, runs commands
* App: **Scriptbook** CLI (`scriptbook`) — later also a DevCentr GUI
* Output: `<file.cmk>.runs/` (`spec/sidecar.adoc`)
* Do **not** translate bash into PowerShell. Name an intent (`cli.install`) and let PlayTime ask the Equivalence Engine.

SLP / `::: tangle` is for **source** literate programming. Scriptbook is for **run on my machine** docs.

Illustrated model: link:https://docs.devcentr.org/general-knowledge/latest/explanation/infrastructure/abstract-playbooks.html[Abstract playbooks]. Component: link:https://docs.devcentr.org/tools/scriptbook/[Explore the docs »]. Essay: link:https://devcentr.org/news/2026-08-13-intents-not-shell-translation[Intents, not shell translation].
Expand Down
Loading