Skip to content

docs: restructure the README, drop the See also blocks - #1

Merged
smnandre merged 3 commits into
ateliersvg:mainfrom
smnandre:docs/readme-rewrite
Aug 13, 2026
Merged

smnandre merged 3 commits into
ateliersvg:mainfrom
smnandre:docs/readme-rewrite

Conversation

@smnandre

Copy link
Copy Markdown
Contributor

Restructures the README around the range of symbologies, and removes every See also block.

  • The 15 supported symbologies are listed in the README itself: that list is what a reader is looking for, and sending them to the documentation for it was one click too many.
  • Cross-links move into the prose of the page that needs them.
  • Drops a committed .DS_Store and does not add it to .gitignore: it belongs in the global ignore file, not in a project one.

69 files. No source change. composer qa passes.

PHPUnit 13 requires php >= 8.4.1, so requiring it here made composer
install insoluble on the 8.3 job: cs, sa and tests all died before running
anything. The package supports PHP 8.3 and the matrix tests it.

The strictness that came with the bump stays. failOnDeprecation,
failOnNotice and failOnEmptyTestSuite are all in the 12.5 schema, so
nothing is lost by holding the version back.
@smnandre
smnandre merged commit 9f99c10 into ateliersvg:main Aug 13, 2026
5 checks passed
@smnandre
smnandre deleted the docs/readme-rewrite branch August 13, 2026 04:42
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