Skip to content

Add the GitHub Pages site and rewrite the README - #2

Merged
evangress merged 2 commits into
mainfrom
site-and-readme
Nov 14, 2026
Merged

evangress merged 2 commits into
mainfrom
site-and-readme

Conversation

@evangress

Copy link
Copy Markdown
Contributor

Adds the project page at docs/index.html (served by GitHub Pages from /docs) and rewrites the README for a first-time reader. These two commits were made after PR #1 was opened and were not part of it.

  • docs/index.html: one semantic HTML page styled by TagBrush.css from its CDN; passes TagCheck with 0 errors and 0 warnings, including browser checks.
  • docs/.nojekyll: serve the folder as-is.
  • README.md: what it is, a real example, install, quick start in both directions, report and exit codes, commands, rules, the LLM/MCP path, status and limits.

Test plan

  • TagCheck --browser on the page
  • uv run pytest, ruff, mypy locally
  • CI

🤖 Generated with Claude Code

evangress and others added 2 commits November 14, 2026 10:04
One semantic HTML page styled by TagBrush.css from its CDN, with two
TagBrush.css variables set (primary colour, reading width). It explains
the tool, shows the unedited translation of corpus/ode_rk4.m, covers the
pipeline, the honesty guarantee, install, commands, the LLM/MCP path and
current coverage from `dualect rules list` and the corpus. docs/.nojekyll
skips Jekyll processing. TagCheck --browser: 0 errors, 0 warnings.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
A one-paragraph statement, a real excerpt of the ode_rk4 translation,
install, quick start in both directions, how to read the report and the
exit codes, the commands, how rules work and how to add one, the LLM/MCP
path, status and limits with numbers from `dualect rules list` and the
corpus, and development commands. CLAUDE.md now points at docs/index.html.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@evangress
evangress merged commit ed4820c into main Nov 14, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant