Simplify README and fix Pages publishing and CI status - #31
Merged
Conversation
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.
The README mixed the project introduction with detailed API documentation, repeated installation instructions, and a crowded diagram. Reduce it to 95 lines with basic C and JavaScript usage, build instructions, and a three-node vertical Mermaid diagram. Move the longer reference into a static GitHub Pages guide and link it from the README and demo.
Update CI so newer upstream dependency releases produce an advisory instead of failing the build; toolchain checks, dependency security tests, and the audit remain required. The Pages workflow now builds pull requests and deploys only from main, includes parser sources in its triggers, and uses the same Emscripten setup action as CI. Badges now track main.
Validation:
The repository's Pages source has been switched to GitHub Actions. Deployment of the new guide will be verified after merge to main.