Skip to content

docs: redesign repo presentation for SSS-tier visual appeal#39

Merged
nopperabbo merged 13 commits into
mainfrom
docs/repo-visual-upgrade
May 23, 2026
Merged

docs: redesign repo presentation for SSS-tier visual appeal#39
nopperabbo merged 13 commits into
mainfrom
docs/repo-visual-upgrade

Conversation

@nopperabbo

Copy link
Copy Markdown
Owner

Summary

Complete visual overhaul of the GitHub repo presentation, making it elegant, tasteful, and visually appealing at first glance.

Changes

New Assets (.github/assets/)

  • banner-dark.svg + banner-light.svg — Wordmark banners using brand palette (warm charcoal + aged-brass amber), system font stack for GitHub compatibility
  • demo.svg — Animated terminal recording showing install → serve → connect flow (SMIL animation)
  • social-preview.png — 1280×640 OG card for link unfurling (Twitter/Slack/Discord)

README Redesign

  • Hero section with <picture> dark/light adaptive banner (Biome/Drizzle pattern)
  • Centered badge row with visual breathing room
  • Dot-separated navigation links (Bun pattern)
  • "Why Kiroxy?" section with 5 differentiator pillars
  • Comparison table vs LiteLLM, One-API, OpenRouter
  • 2×3 screenshot grid using HTML table (replaces sequential images)
  • Condensed sections with consistent <br> spacing
  • Elegant footer with sponsor/bug/discuss links

CONTRIBUTING.md Polish

  • Centered header with subtitle
  • Philosophy as comparison table
  • Prerequisites as table
  • Commit scopes as table
  • Code style in collapsible <details> sections
  • Visual footer with links

Infrastructure

  • .github/release.yml — GitHub native release notes with emoji categories
  • .goreleaser.yml — Docker pull command + cosign note + community links in footer
  • Layout.astro — Added og:image, og:site_name, twitter:image, summary_large_image
  • social-preview.png in landing public dir for OG serving

GitHub Settings (via API)

Design Patterns Used

  • Biome/Drizzle<picture> dark/light adaptive SVG
  • Bun — Centered dot-navigation
  • Hono — Emoji feature bullets
  • Ollama — Ultra-minimal quick start
  • Caddy — Architecture diagram + env var tables
  • Charmbracelet — Warm footer

Manual Steps Needed After Merge

  1. Upload .github/assets/social-preview.png via Settings → General → Social preview
  2. Pin discussion 👋 Welcome to kiroxy Discussions #38 via Discussions UI

Verification

  • All 4 SVGs valid XML (xmllint)
  • Go build passes
  • Social preview PNG: 1280×640
  • No Go code changes (docs-only)

nopperabbo added 11 commits May 23, 2026 14:30
- Add golangci-lint with 25+ linters (.golangci.yml)
- Add CodeQL SAST scanning (Go + JavaScript)
- Add container publishing to ghcr.io (multi-arch amd64/arm64)
- Add cosign release signing + SBOM generation (SPDX)
- Add Codecov integration (informational mode)
- Add semantic PR title enforcement
- Add auto-labeler by file path
- Add lock-threads workflow (30 days)
- Add stale issue bot (60 days warn, 14 days close)
- Add benchmark regression detection in CI
- Add dependency review (block vulnerable new deps)
- Add Go native fuzz testing in CI
- Add OpenSSF Scorecard workflow + badge
- Pin ALL GitHub Actions to full SHA (supply chain hardening)
- Add GOVERNANCE.md (versioning, release process, supply chain)
- Update dependabot: monthly → weekly, increased PR limits
- Update README: 8 badges, Docker pull, cosign verify instructions
- Update SECURITY.md: supply chain security section
- Fix E2E test: dismiss wizard scrim before metrics interaction
golangci-lint v2.12.2 requires 'version: "2"' in config.
Also removes 'typecheck' linter (always-on in v2).
- Move linters-settings under linters.settings (v2 schema)
- Move issues.exclude-rules under linters.exclusions.rules (v2 schema)
- Remove benchmark-action dependency (requires gh-pages branch)
- Simplify to artifact-only benchmark results
max-issues-per-linter and max-same-issues are not valid under
linters.exclusions in v2. Default (0 = unlimited) is what we want.
In v2, gofmt/gofumpt/goimports are formatters, not linters.
Pre-existing lint issues in the codebase should not block PRs.
Only new code introduced in a PR is checked.
Same fix as metrics.spec.ts — fresh server shows wizard scrim
that blocks tab clicks.
Each page.goto() re-triggers the scrim on fresh server.
Dismiss after every navigation, not just in beforeEach.
Mobile viewport may have different hit targets. Force click bypasses
actionability checks. Added small delay after dismissal for render.
- Add dark/light SVG banners with brand palette (system font stack)
- Add animated terminal demo SVG showing quick start flow
- Add social preview image (1280x640 PNG + SVG source)
- Redesign README: hero section, centered badges, dot-nav links,
  'Why Kiroxy?' pillars, comparison table, 2x3 screenshot grid
- Polish CONTRIBUTING.md: tables, collapsibles, visual hierarchy
- Add .github/release.yml for GitHub native release notes categories
- Update goreleaser footer: Docker pull, cosign note, community links
- Add og:image + twitter:image to landing page Layout.astro
- Use system font stacks in SVGs (GitHub strips external font loads)
…llapsibles

- Upgraded SVG banners: gradient backgrounds, ambient glow, stats row
- Badges: flat-square → for-the-badge with kiroxy amber palette
- Structure: collapsible details for reference sections (env vars, API, CLI, Docker)
- Why Kiroxy: 2x2 card grid instead of table
- Screenshots: image-first with caption below (Dub/Supabase pattern)
- Architecture: simplified ASCII diagram
- Footer: Repobeats placeholder for activity chart
- Overall: less text above fold, more visual breathing room
@nopperabbo nopperabbo merged commit 29f33c1 into main May 23, 2026
12 checks passed
@nopperabbo nopperabbo deleted the docs/repo-visual-upgrade branch May 23, 2026 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant