Skip to content

docs(readme): cut the README back to an overview and a pointer - #145

Merged
Ilyes512 merged 1 commit into
mainfrom
docs-simplify-readme
Sep 13, 2026
Merged

Ilyes512 merged 1 commit into
mainfrom
docs-simplify-readme

Conversation

@Ilyes512

Copy link
Copy Markdown
Member

Summary

  • Restructure the README along the same lines as labelsync's: tagline, demo, a project.yml sample, the command block, a short feature list, install, getting started, contributing. 218 → 113 lines.
  • Drop the Scripting section — a reference section that belonged on the docs site, not in the README.
  • Move the two parts the docs site was missing: terminal-width capping, COLUMNS and OSC 8 hyperlinks plus the NDJSON semantics → commands/global-flags.md; the Repository column's label-vs-value distinction and the legacy local: prefix → commands/template.md.
  • Delete what was already documented: the stdout/stderr contract and --output validation (global-flags.md), the non-interactive/CI behaviour (use.md), the update-status rules (template.md), and the __delimiters / __specs__version table (template-structure.md).
  • Collapse the four development-environment subsections into a short Contributing section pointing at .github/instructions/executing-commands.md, which already covers the Docker/go-builder mechanics.
  • Fix: the README credited sprig for the template functions — it's Sprout.

The Scripting section documented the stdout/stderr contract, NDJSON
semantics, table widths and the Repository column label — a reference
section the README had no business carrying. The parts the docs site was
missing move to global-flags and template; the rest was already there.
@Ilyes512
Ilyes512 merged commit efc753d into main Sep 13, 2026
5 checks passed
@Ilyes512
Ilyes512 deleted the docs-simplify-readme branch September 13, 2026 21:26
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.

1 participant