Skip to content

feat(docs): surface Garlemald-Client contributor docs under Contributing#4

Merged
swstegall merged 1 commit into
mainfrom
feat/client-contributing-docs
Jun 6, 2026
Merged

feat(docs): surface Garlemald-Client contributor docs under Contributing#4
swstegall merged 1 commit into
mainfrom
feat/client-contributing-docs

Conversation

@swstegall

Copy link
Copy Markdown
Owner

Wires the new Garlemald-Client contributor docs into the Garlemald Client project page's Contributing section — using the same scalable group: "Contributing" mechanism already shipped for Garlemald-Server (site #1).

Change

Registry-only. Tag the client's docs with group: "Contributing" in src/data/registry.mjs:

  • CONTRIBUTING.md, docs/architecture.md, docs/dev-environment.md, docs/agents.md, CLAUDE.md, AGENTS.md, docs/RELEASING.mdContributing
  • ws2_32-proxy/README.md, NOTICE.md, LICENSE.md stay in the default Reference section.

The Docs-tab grouping UI, the fetch pipeline (group carried through fetch-content.mjs), and the routes were all added with the server work — so no code changes are needed here. This is exactly the "add another project later with a one-line-per-doc registry change" path that mechanism was built for.

Validation

  • Registry parses (client: 11 docs, 7 under Contributing).
  • npm run typecheck clean; npm run build static-exports all pages.
  • content.json intentionally not regenerated — the deploy workflow + daily cron rebake it. The client docs land on develop via Garlemald-Client#27; fetch-content fails soft on the 404 until then, so the section populates on the next build after that merge.

🤖 Generated with Claude Code

Wire the new Garlemald-Client contributor docs (architecture, developer
environment, AI-agent guides, CONTRIBUTING, CLAUDE.md, AGENTS.md, releasing) into
the client project's Docs tab via the existing scalable `group: "Contributing"`
mechanism — the same one already used for Garlemald-Server.

Registry-only change: tag the client's docs with `group: "Contributing"` in
src/data/registry.mjs. The Docs-tab grouping, fetch pipeline, and routes are
already in place, so no code changes are needed.

content.json is intentionally not regenerated here; the deploy workflow + daily
cron rebake it. The client docs land on `develop` via Garlemald-Client#27 and
appear here automatically on the next build (fetch-content fails soft on the 404
until then).

Verified: registry parses; `npm run typecheck` clean; `npm run build` static-exports.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@swstegall
swstegall merged commit 20fbb1a into main Jun 6, 2026
@swstegall
swstegall deleted the feat/client-contributing-docs branch June 6, 2026 22:24
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