Skip to content

Standardize documentation code blocks - #28

Merged
afrigon merged 2 commits into
mainfrom
docs-code-blocks
Sep 7, 2026
Merged

afrigon merged 2 commits into
mainfrom
docs-code-blocks

Conversation

@afrigon

@afrigon afrigon commented Sep 7, 2026

Copy link
Copy Markdown
Owner
  • sh for commands the reader types, without a $ prompt; kdl for manifest excerpts; text for synopses, output, trees, and file contents; ini stays for the systemd unit
  • blocks that mixed a command with its output are split into an sh block followed by a text block
  • the convention is written down in CLAUDE.md so future pages follow it

Closes #16

- sh for commands, without a prompt; text for output and synopses; kdl for manifests
- convention recorded in CLAUDE.md

Closes #16
@afrigon afrigon self-assigned this Sep 7, 2026
@afrigon
afrigon merged commit e753572 into main Sep 7, 2026
1 check passed
@afrigon
afrigon deleted the docs-code-blocks branch September 7, 2026 17:38
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.

stadardize documentation code blocks

1 participant