Repository navigation
Add static Chalkline explainer and scripted receipt demo - #19
Merged
Merged
Conversation
Signed-off-by: David Hamilton <daveh@squareup.com>
Signed-off-by: David Hamilton <daveh@squareup.com>
delkc
self-requested a review
September 22, 2026 14:57
delkc
approved these changes
Sep 22, 2026
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
Adds a static website explaining what Chalkline does, how to set it up, and how teams maintain their writing guidance. The layout is inspired by the Ghost site and uses plain HTML, CSS, and JavaScript with no build step.
Two fictional examples show a draft alongside its facts, writing rules, and traceability receipt. Readers can remove a required source to see the draft withheld. The examples are prewritten and illustrate the proposed work in #18.
Publishing
Adds a GitHub Pages workflow that checks pull requests without publishing, then publishes website changes after they merge to
main. Only the HTML, CSS, and JavaScript files are deployed; tests, documentation, and writing references are excluded. Repository Pages settings are configured to use GitHub Actions.The site will be available at https://block.github.io/chalkline/ after the first successful deployment. There is no hosted preview yet.
Testing
JavaScript syntax checks and demo tests pass locally. Checked desktop and mobile layouts, task switching, and removing and restoring a required source. Screen-reader testing is still outstanding. The first Pages deployment will run after merge.