chore - add Prismplane docs site and strict docs CI (#9)#98
Draft
dannymeijer wants to merge 35 commits into
Draft
chore - add Prismplane docs site and strict docs CI (#9)#98dannymeijer wants to merge 35 commits into
dannymeijer wants to merge 35 commits into
Conversation
# Conflicts: # README.md # docs/architecture.md # docs/docs_map.md # docs/language/reference/substrait/read_root_binding_contract.md # docs/release_notes/v0_1.md
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 existing IncQL documentation into a strict MkDocs Material site and completes the screenshot-annotated Prismplane landing page. The homepage now explains IncQL as a typed data-logic plane through a distinct physical Prism visual, accessible syntax-surface examples, and a clearer path from authoring to inspection and execution.
Closes #9.
Deployment note: this remains a draft. It does not publish the unfinished site to production; Pages continues to deploy from
mainonly after merge.Type of change
docs/rfcs/*)Area(s)
Select the primary areas touched (labels sync from checked lines when the triage workflow runs):
Key details
docs/javascripts/prismplane.js, loads it through MkDocs, adds local Material-style SVG assets, replaces the previous process-flow raster variants withprocess-flow-stage-v3.png, and preserves a readable progressive-enhancement fallback when JavaScript is unavailable.Testing / verification
make ci(ormake fmt-check,make build,make test)Manual verification notes:
make ci: formatting, test-style, vocab-companion tests, 216 registry checks, library build, and 269 IncQL tests passed. Its final public-consumer target initially encountered sandboxed DNS;make smoke-consumerthen passed with crates.io access.mkdocs build --strict -d /tmp/incql-site-publishnode --check docs/javascripts/prismplane.jsgit diff --checkandgit diff --cached --checkDocs impact
If docs updated:
docs/index.md,mkdocs.yml,docs/stylesheets/prismplane.css,docs/javascripts/prismplane.jsChecklist