Skip to content

docs(site): terminal demo, workflows and security on the homepage - #34

Merged
NaNIsaac merged 1 commit into
mainfrom
docs/home-redesign
Oct 23, 2026
Merged

NaNIsaac merged 1 commit into
mainfrom
docs/home-redesign

Conversation

@NaNIsaac

Copy link
Copy Markdown
Owner

Tier: low

  • Homepage only (en and ko): terminal demo tabs, five workflow cards and a security summary replace the feature cards.
  • The hero GIF and poster are regenerated from the same run as the text, so the token count and file list agree (~545 tokens, two files).
  • No change to the CLI, install scripts, README or other pages, apart from four Korean headings that get ASCII ids so the homepage links reach them.

Stacked on #29 (base docs/home-install-platforms); retarget to main after #29 merges.

Changes

  • Hero: title, one line, install selector from docs: offer platform-specific installation on the homepage #29, Get Started and GitHub. The name is solid burnt orange; the radial gradients, the orange glow under the demo and the feature-card hover motion are gone.
  • See it work: cdg scan, cdg digest, cdg cap, cdg pack as VitePress code-group tabs (keyboard: arrow keys switch tabs). The output is from one run of the cdg 0.12.2 release binary on Windows in a pseudo console, status lines included (Copied snapshot to clipboard, Digest 2 files, ~160 tokens). Long output scrolls inside the block.
  • Common workflows: whole project, files plus imports (-r), changes since cdg mark, failing test with cap and pack, MCP. Each links to the recipe or reference section. New HomeWorkflows.vue reads them from frontmatter, so en and ko share the component.
  • Security: stays local, never included, masked, not a guarantee; links to the Security page. Claims checked against site/security.md, rust/Cargo.toml (no HTTP client), src/codigest (no network calls) and rust/src/output.rs.
  • The pytest output in the GIF is now uncolored: cdg cap runs the child on a pipe (rust/src/runner.rs), so that is what a terminal shows.

How the demo was produced

Sample project: committed prices.py with percent / 100, then edited to percent so test_prices.py fails. In one session: cdg scan -s, cdg digest -s, cdg cap -- pytest -q, cdg pack with CODIGEST_CLIPBOARD=system (the SSH session would otherwise pick OSC 52). The GIF is rendered with docs/demo/make_gif.py run from a copy, so docs/demo/demo.gif used by the README is unchanged.

Validation

  • npm ci && npm run build passes.
  • Headless Chromium, en/ko home and installation at 1440x900 and 390x844, dark and light: 16 renders, no console errors, no failed requests, no horizontal overflow. Install selector, copy and code-group keyboard switching work.
  • Internal links: one broken anchor left, /ko/rust-port#설치, fixed in fix(site): link the Korean install section by an ASCII id #32.
  • Not checked: screen readers, Safari/Firefox, deployed Pages.

Screenshots

Before (#29) After

Show scan, digest, cap and pack as tabs with output from one run of the
0.12.2 binary, and regenerate the hero GIF and poster from that same run.
Replace the feature cards with five workflows and a short summary of what
is shared and what is kept out. Drop the gradients, the orange glow and the
card hover motion. Korean headings linked from the homepage get ASCII ids.
@NaNIsaac
NaNIsaac changed the base branch from docs/home-install-platforms to main October 23, 2026 06:39
@NaNIsaac
NaNIsaac merged commit 6f60d96 into main Oct 23, 2026
5 checks passed
@NaNIsaac
NaNIsaac deleted the docs/home-redesign branch October 23, 2026 15:49
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