Skip to content

Add the project website at askkey.sudohg.com - #184

Merged
sudoHG merged 2 commits into
mainfrom
website-160
Oct 13, 2026
Merged

sudoHG merged 2 commits into
mainfrom
website-160

Conversation

@sudoHG

@sudoHG sudoHG commented Oct 13, 2026

Copy link
Copy Markdown
Owner

Refs #160. Adds the bilingual one-page website and the Pages workflow. The issue stays open until Pages and DNS are set up (step 4) and the acceptance check against https://askkey.sudohg.com passes.

What's in it

  • site/: English at /, Simplified Chinese at /zh/. Sections: hero, "How it works" film, permissions (Allow / Ask every time / Hidden as seals), clients, limits, download. Static HTML and CSS plus motion.js for the seal stamping, the client lines and the hanging access card.
  • site-src/how/: readable source of the film (three.js r186, MIT, bundled with esbuild into site/how/how.js, licence shipped next to it). npm run build also stamps content hashes onto the CSS and JS URLs so a new page never pairs with a cached old script. See site-src/how/README.md.
  • .github/workflows/pages.yml: deploys site/ on pushes to main that touch site/; actions pinned to commit SHAs.
  • scripts/check_hygiene.py: allows Chinese in the two pages. README.md and README.zh-CN.md link to the site.

Deviations from the issue, approved by the maintainer in session

  • Step 3 (recorded demo) is replaced by the real-time film; the hero is a still photograph with the "准" seal.
  • The download button links to releases/latest/download/AskKey.dmg, which every release publishes since Publish stable-named release assets for direct downloads #165; no version number is hard-coded. A smaller link goes to the releases page.
  • The clients section names eight further MCP tools (Claude Desktop, VS Code, Kiro, Trae, Windsurf, Qwen Code, Zed, Cline) as "by hand" clients. They come from the README's "Other MCP clients" path and each tool's own MCP docs; none was tested with Ask Key. Names only, no third-party logos. Grok is named "Grok Build", xAI's name for the grok CLI that Ask Key connects to.

Fonts and images

Shipped fonts: Hanken Grotesk and IBM Plex Mono (Latin-1, unmodified), OFL, licences in site/fonts/. System fonts are only named in CSS. Every image with text (seals, No-WebGL posters, share images) is set in open fonts only (Source Han Serif/Sans, Hanken Grotesk).

Evidence

  • python3 scripts/check_hygiene.py: passed. python3 scripts/check_module_deps.py: passed.
  • External URLs in site/: only href links to github.com/sudoHG and askkey.sudohg.com, plus www.w3.org namespaces; the bundle also contains one citation URL inside a three.js shader comment string. No external src, url() or @import.
  • Headless Chrome, both pages: no horizontal scrolling and no page errors at 375, 768, 1280 and 1920 px; every request goes to the site's own host, no 4xx.
  • Also checked at 360, 393, 412, 440, 744, 820, 1032 (portrait tablets) and 1180, 1376 (landscape tablets): download button on the first screen everywhere, upright film on phones and portrait tablets.
  • Real devices: the maintainer checked iPhone Safari over the LAN and Safari on the Mac.

After merge (maintainer)

  1. Settings → Pages: source GitHub Actions, custom domain askkey.sudohg.com, enforce HTTPS.
  2. Cloudflare: CNAME askkey -> sudohg.github.io, DNS only.

A real-time three.js scene on a walnut desk acts out one request: the AI
finds the key in Ask Key's catalog, asks for it, waits for the reader's
approval in Ask Key's real prompt, and the key goes straight to the
program while the AI gets back one line. The reader's click decides the
ending. Phones and portrait tablets get an upright composition, reduced
motion gets a still telling, and browsers without WebGL2 get posters.

Readable source lives in site-src/how and is bundled with esbuild into
site/how; three.js ships with its MIT licence. Text in images uses only
open fonts.
A bilingual one-page site (English at /, Simplified Chinese at /zh/):
the hero, the film, per-key permissions stamped as seals, the AI tools
that connect in one click or by hand, the limits, and the download, with
links to the repository, release notes and the security model.

The site is static HTML and CSS with a small script for motion. It loads
nothing from other hosts, ships only open fonts, and busts caches with
content hashes. A Pages workflow deploys site/ from main. The READMEs
link to the site, and the hygiene check allows Chinese in the two pages.
@sudoHG
sudoHG merged commit 966247b into main Oct 13, 2026
2 checks passed
@sudoHG
sudoHG deleted the website-160 branch October 13, 2026 10:55
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