chore - add Prismplane docs site and IncQL learning system (#9)#98
Draft
dannymeijer wants to merge 57 commits into
Draft
chore - add Prismplane docs site and IncQL learning system (#9)#98dannymeijer wants to merge 57 commits into
dannymeijer wants to merge 57 commits into
Conversation
dannymeijer
added a commit
that referenced
this pull request
Jul 14, 2026
dannymeijer
force-pushed
the
feature/9-docs-ci
branch
from
July 19, 2026 12:27
9546d88 to
b3adf75
Compare
dannymeijer
force-pushed
the
feature/9-docs-ci
branch
from
July 27, 2026 09:02
b32521f to
b03b0b3
Compare
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.
Summary
This PR turns the IncQL documentation into a strict MkDocs Material site and
establishes Prismplane as its shared visual and information-architecture
direction. It combines the responsive crystal interface with a route-first
learning system, task Guides, exact Reference material, the architecture
narrative, the Part-based IncQL Book, and a searchable RFC Context Reader.
Closes #9.
Deployment note: this PR intentionally remains draft. The documentation can be
published for design and navigation QA through the existing manual
workflow_dispatchpath without merging the PR.Type of change
docs/rfcs/**)Area(s)
Select the primary areas touched (labels sync from checked lines when the triage workflow runs):
Key details
self-hosted typography and optimized brand assets; introduces newcomer routes
for SQL, Spark/DataFrame, database, and Incan readers; organizes Guides by
outcome and Reference by decision point; adds quickstart, read/write, join,
troubleshooting, capability, and audience-bridge pages; and preserves the
interactive Architecture and RFC-reader experiences on desktop and mobile.
enhancement for the responsive drawer and Architecture tour, deterministic
RFC catalog generation, dependency-free Node interaction contracts, local
Manrope/Outfit assets, and WebP images with PNG fallbacks. The theme ownership
and browser QA matrix are documented for future contributors.
IncQL authoring forms, Prism evidence, portable Substrait boundary, Session,
and current DataFusion adapter. It does not present future backends,
distributed execution, or cost-based optimization as shipped behavior.
Browser lifecycle behavior is covered by structural and pure-contract tests
plus manual browser QA rather than an automated real-browser CI suite. Legacy
browsers receive larger PNG fallbacks. The included quickstart is website
content; compiler execution against Incan 0.5 is a separate validation scope.
Testing / verification
make ci(ormake fmt-check,make build,make test)Manual verification notes:
make docs-buildpassed: 33 Python tests, 12 Node tests, RFC catalogvalidation, and strict MkDocs build.
node --check docs/javascripts/prismplane.jspassed.node --check docs/javascripts/crystalline.jspassed.git diff --checkpassed.Design records with no broken images or horizontal overflow.
responsive drawer works with pointer and keyboard input.
height.
keyboard behavior, mobile master/detail views, and bookmarkable URL state.
claims, scope, test style, maintainability, architecture, and source quality.
Docs impact
Primary links after a manual Pages deployment:
Checklist