Repository navigation
README rewrite and a banner drawn by the library - #15
Merged
Merged
Conversation
- The banner is docs/banner.py: the script reads its own source, shows the D2 it produces and the rendered banner, which contains itself. CI runs it so it keeps working. - Drop Terrastruct's D2 banner and the old example image. - README: install, quick start with real output, one short section per task, render options, validate and fmt, value checks, py-d2 notes. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The PyPI description now matches: Build D2 diagrams with Python code. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Banner.
docs/banner.pydraws the new banner using d2-python. The left box shows the script's own source. The middle box shows the start of the D2 text the script produces. The right box shows the rendered banner, so the banner contains smaller copies of itself. CI runs the script so it keeps working. The old banner was Terrastruct's D2 logo, and it's removed together with the old example image.README. The README is rewritten in plain language. It covers:
binextra anduvx d2-binvalidateandfmtChecked locally: every README snippet runs and passes
d2 validate. ruff, ty and the tests are clean.🤖 Generated with Claude Code