Skip to content

feat(repo): add zpress documentation site#85

Draft
zrosenbauer wants to merge 16 commits intomainfrom
feat/zpress
Draft

feat(repo): add zpress documentation site#85
zrosenbauer wants to merge 16 commits intomainfrom
feat/zpress

Conversation

@zrosenbauer
Copy link
Member

Summary

  • Adds zpress as the documentation framework, wired up to all existing docs
  • Installs @zpress/kit and creates zpress.config.ts mapping the full information architecture
  • Adds docs scripts (docs:dev, docs:build, docs:serve, docs:sync, docs:clean)
  • Updates .gitignore for .zpress/ build artifacts

Sections

Section Source
Introduction docs/README.md
Concepts docs/concepts/*.md
Guides docs/guides/*.md
Reference docs/reference/*.md
Contributing contributing/ (concepts, guides, standards)
Packages Metadata for all 5 monorepo packages

Known issues

3 broken links in contributing docs — relative references to CLAUDE.md, CONTRIBUTING.md, and contributing/README.md that exist on GitHub but not in the docs site. Will address in a follow-up.

Test plan

  • pnpm docs:dev starts dev server at localhost:6175
  • pnpm docs:sync syncs all 50 pages without errors
  • All sections render correctly in sidebar
  • Fix or remove broken links in contributing docs

@changeset-bot
Copy link

changeset-bot bot commented Mar 18, 2026

⚠️ No Changeset found

Latest commit: 45cde70

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Add zpress configuration, Vercel static site deployment config,
and resolve pnpm-lock.yaml merge conflict with main.

Co-Authored-By: Claude <noreply@anthropic.com>
@vercel
Copy link

vercel bot commented Mar 18, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
oss-kidd Ignored Ignored Preview Mar 18, 2026 11:55pm

Request Review

@codspeed-hq
Copy link

codspeed-hq bot commented Mar 18, 2026

Merging this PR will not alter performance

✅ 2 untouched benchmarks


Comparing feat/zpress (45cde70) with main (16afb63)

Open in CodSpeed

Relative links to CLAUDE.md, CONTRIBUTING.md, and contributing/README.md
break after zpress content sync since those files are outside the sync
boundary. Replace with absolute GitHub URLs as a workaround.

See: joggrdocs/zpress#48

Co-Authored-By: Claude <noreply@anthropic.com>
- Rewrite introduction.md as user-facing intro (was developer README)
- Add quick-start.md with minimal getting-started guide
- Add features, packages, nav, and sidebar.below to zpress config
- Move Contributing to sidebar-only (isolated section)
- Replace zpress-generated SVG assets with braille art from repo banner
  recolored to docs purple theme (#a78bfa), without the generated marker
  so zpress won't overwrite them

Co-Authored-By: Claude <noreply@anthropic.com>
zrosenbauer and others added 7 commits March 18, 2026 18:45
- Widen logo viewBox to 1060 and use text-anchor="middle" to prevent cutoff
- Center icon K art at (256, 65) with text-anchor="middle" for dead center

Co-Authored-By: Claude <noreply@anthropic.com>
Remove text-anchor="middle" which centered each line independently and
warped the art. Instead keep lines left-aligned and shift the entire
group as a block. Widen logo viewBox to 960 to prevent clipping.

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
49 chars wide, 23 lines (y 9-273). Computed translate from measured
art block size to center within 512x512 background.

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
- Logo/icon brand color to #d8b4fe (violet-300, bright neon purple)
- Set zpress theme to midnight (dark mode)

Co-Authored-By: Claude <noreply@anthropic.com>
zrosenbauer and others added 2 commits March 18, 2026 19:12
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
zrosenbauer and others added 3 commits March 18, 2026 19:16
Keep vercel and zpress ignore entries from feat/zpress branch.

Co-Authored-By: Claude <noreply@anthropic.com>
Eliminates MODULE_TYPELESS_PACKAGE_JSON warning from zpress dev.

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
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