Skip to content

Repository navigation

docs: update the README to match current behavior #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
e54-bot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update the README to match current behavior #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ implementation:
support;
- `wright` for the unified tooling product: CLI commands, lint, analysis,
language server, CI output, and agent-facing APIs;
- `language-provider-protocol` for LPP protocol contracts.
- `language-provider-protocol` for LPP protocol contracts;
- `skills` for the agent skills and `homebrew-tap` for the Homebrew formula;
- `benchmark-suite` for the published agent results.

Do not treat an issue state, an unreleased branch, or a hidden command as proof
that a capability ships. Planned features go in the agents section's "Coming
Expand Down Expand Up @@ -54,10 +56,10 @@ browser-language redirect; readers switch from the header language menu.
规则, 动作, 值, 服务器负载) and puts a space between CJK text and Latin words.
- Long Chinese headings may use `\u200b` to mark where they are allowed to
wrap; headings otherwise break only at spaces and punctuation.
- To add a locale: add it to `src/lib/locales.ts`, add a content file, add the
path to `prerender.entries` in `vite.config.ts`, add its share-image file
in `src/lib/seo.ts`, regenerate the PNGs with
`swift scripts/share-cards/render.swift` on macOS, and extend
- To add a locale: add it to `src/lib/locales.ts`, add a content file, add
`/<locale>` and `/<locale>/results` to `prerender.entries` in
`vite.config.ts`, add its share-image file in `src/lib/seo.ts`, regenerate
the PNGs with `swift scripts/share-cards/render.swift` on macOS, and extend
`scripts/verify-build.mjs`. The sitemap is generated from the locale list.

Search and share metadata is prerendered from each locale's `meta` block.
Expand All @@ -80,7 +82,7 @@ state. The release bucket must allow cross-origin `GET` from `wrightkit.dev`.

## Stack

- SvelteKit with `@sveltejs/adapter-static`
- SvelteKit 3 with `@sveltejs/adapter-static`
- Svelte 5
- TypeScript
- Tailwind CSS v4
Expand All @@ -90,7 +92,7 @@ client-side data service.

## Local development

Requires Node.js 20.19+ and `pnpm`.
Requires Node.js 22.17+ and `pnpm`. CI uses Node.js 26.

```sh
pnpm install
Expand Down
Loading