docs: add logo, MIT license, and house-style README + landing page#3
Merged
Conversation
Rework the README and Documenter landing page into the same house style as EDKit.jl and InfiniteTEBD.jl: centered SVG logo, italic tagline, badge row, a verified 60-second TEBD demo, a Choose Your Path table, a repository map, and a conventions section (the previous agent-oriented notes, folded in). Add a tensor-network logo as a finite open MPS in mixed-canonical form acted on by a two-site gate (light + dark variants) plus a favicon, wire the favicon through make.jl with an authors field, and add an MIT LICENSE. Co-Authored-By: Claude Opus 4.8 (1M context) <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
1 participant
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.
Reworks the README and Documenter landing page into the same house style as EDKit.jl and InfiniteTEBD.jl, and adds project branding.
Highlights
docs/src/assets/): a tensor-network mark — a finite open-boundary MPS in mixed-canonical form (triangles pointing to the orthogonality center) acted on by a Julia-blue two-site gate. Light (logo.svg) + dark (logo-dark.svg) variants and afavicon.ico. Deliberately distinct from InfiniteTEBD.jl's row-of-circles.docs/src/index.md): matching hero with the demo and a Choose Your Path table.make.jl: addedauthorsand wiredassets=["assets/favicon.ico"](Documenter auto-detects the logos).Verification
Szrelaxes toward 0 and half-chain entanglement grows0 → ≈1.47.julia --project=docs docs/make.jlbuilds cleanly — doctests pass, all pages render, andindex.htmlreferences the logo, dark logo, and favicon.🤖 Generated with Claude Code