Skip to content

Rebuild the website with native motion and source API documentation - #158

Merged
MelbourneDeveloper merged 3 commits into
mainfrom
codex/website-redesign
Oct 3, 2026
Merged

MelbourneDeveloper merged 3 commits into
mainfrom
codex/website-redesign

Conversation

@MelbourneDeveloper

@MelbourneDeveloper MelbourneDeveloper commented Oct 3, 2026 •

Copy link
Copy Markdown
Owner

TLDR;

Rebuild the documentation website with an interactive HTTP outcome explorer, source-generated API references, and one shared prose style. Enforce a 2,500-byte total CSS budget and verify the site before GitHub Pages deployment.

Details

  • Replace the theme plugin with responsive local Eleventy layouts for English and Chinese homepages, guides, API pages, examples, and the journal. Preserve existing content and taxonomy routes while repairing broken links and duplicate headings.
  • Animate request/result paths directly in canvas. Outcome controls update the diagram and C# branches; keyboard navigation, reduced motion, pause/resume, offscreen suspension, and page restoration are supported.
  • Export public C# declarations and XML documentation through a Roslyn tool into Markdown and JSON reference pages, with overload anchors and source links. Compile and exercise the same example source rendered in both languages.
  • Reject CSS over 2,500 raw UTF-8 bytes, inline/external styles, CSS injection, missing routes, bad canonicals, and invalid crawl metadata during builds. Guides, articles, and API references share .prose typography.
  • Test root and GitHub Pages path-prefix builds. The Pages workflow runs export/guard tests and browser checks on PRs, then deploys verified main builds using the configured Pages origin and path.
  • Remove obsolete theme dependencies, update patched transitive packages, and make the preview command use its own port without terminating other services.

How Do The Tests Prove The Changes Work?

Browser regressions exercise all three outcomes through repeated edits and compare actual canvas pixels for motion, pause, and reduced-motion behavior. They cover keyboard/mobile navigation, no-JavaScript content, translation routes, all generated API headings on mobile, and identical computed prose styles across documentation, blog, and API pages.

Exporter fixtures change real declarations and XML comments, verify distinct/stable overload anchors and qualified symbol IDs, exclude private declarations, and require deterministic output. The shared examples compile against RestClient.Net 7.3.1 and pass 28 runtime assertions for requests, responses, errors, headers, factories, and cancellation without network requests. Build-guard fixtures prove the CSS limit rejects the 2,501st byte and cannot be bypassed by inline styles, external assets, SVG styles, or JavaScript injection.

Final local validation: 105 browser tests passed with zero failures/skips; all 23 exporter, guard, and example tests pass; 110 generated pages pass the site audit at 2,491 / 2,500 CSS bytes. Repository CSharpier and workflow actionlint checks pass.

Comment thread Website/scripts/check-site.js Fixed
Comment thread Website/tests/fixtures.js Fixed
@MelbourneDeveloper
MelbourneDeveloper merged commit f62b1ba into main Oct 3, 2026
8 checks passed
@MelbourneDeveloper
MelbourneDeveloper deleted the codex/website-redesign branch October 3, 2026 12:48
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.

2 participants