docs: README in example-led (Julia-package) form + EXPLAINME deep-dive#45
Merged
Conversation
…-dive Reshape README.adoc into the canonical Julia-package idiom: clean badges, one-line pitch, a concrete runnable example up front, install, differentiators, implemented-vs-planned features, docs links, where-it-fits (poly-ssg/ddraig/boj), license. Lead with the real positioning (accessibility-first, metadata-driven; verified+agent-native as trajectory per ADR-0001) instead of the generic 'pure functional SSG'. Add EXPLAINME.adoc: developer deep-dive of the build pipeline, module map, accessibility invariants, content/metadata model, known gaps, and the ADR-0001 direction. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WN6nPWWe4dvXfoqBG6auWN
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
hyperpolymath
marked this pull request as ready for review
June 23, 2026 22:15
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
2 participants
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.
What
The core documentation upgrade you asked for.
README.adoc— reshaped into the canonical Julia-package idiom (the "Axiom.jl shape"): clean badges → one-line pitch → a concrete runnable example up front (source tree →casket-ssg build→ accessible_site/) → install → differentiators → implemented-vs-planned features → docs links → where-it-fits → license. It now leads with the real positioning — accessibility-first, metadata-driven; verified + agent-native as the trajectory — instead of the generic "pure functional SSG in Haskell". Stays honest (the truthed implemented/planned split is preserved).EXPLAINME.adoc(new) — developer deep-dive: build pipeline, module map (CasketGnosis+ theGnosis.*set, and the legacyCasket.hs), accessibility invariants (FlexiText/Tri-Guard,addThScope, accessible default theme), content/metadata model, known gaps (Pandoc build break;SixSCMstill on.scmnotdescriptiles/*.a2ml), and the ADR-0001 direction.Notes
mainreds (Pandoc build; Hypatia findings) — neither introduced here.Axiom.jlto mirror exactly; happy to re-shape if a particular one was meant).🤖 Generated with Claude Code
https://claude.ai/code/session_01WN6nPWWe4dvXfoqBG6auWN
Generated by Claude Code