Skip to content

docs: implement Kovina Repository Standard#82

Merged
sparshsam merged 1 commit into
mainfrom
docs/kovina-standard
Jun 29, 2026
Merged

docs: implement Kovina Repository Standard#82
sparshsam merged 1 commit into
mainfrom
docs/kovina-standard

Conversation

@sparshsam

Copy link
Copy Markdown
Owner

Kovina Repository Standard

Transform OpenReader's repository into a premium software product showcase following the new Kovina Repository Standard — a reusable specification for all Open* projects.

README (11-section layout)

  1. Hero — Logo, tagline, large hero screenshot
  2. Primary CTA — Microsoft Store, Portable Release, Project Website, Source Code
  3. Gallery — Dark mode, PDF tools, about dialog, sample document
  4. Why OpenReader — 4 value propositions
  5. Features — Two-column grid with 12 custom Kovina SVG icons
  6. Designed For — 5 audience segments
  7. Design Philosophy — Quote + philosophy paragraph
  8. Built With — Icon row (8 tech SVGs)
  9. Version Journey — Timeline v0.1.0 → v1.2.4
  10. License — AGPLv3 + CTA badges
  11. Part of the Open Collection — 9 Open* apps with icons and links

New Asset Structure

assets/
├── hero/           # Product hero image
├── screenshots/    # Feature and UI screenshots  
├── icons/          # 20 Kovina-style SVG icons (features + tech + app)
└── branding/       # App icons (all sizes), store assets

New Documentation

  • docs/Architecture.md — System architecture
  • docs/Deployment.md — CI/CD and distribution
  • docs/Testing.md — Test suite and quality gates
  • docs/Contributing.md — Contributor guide
  • docs/playbooks/KOVINA_REPOSITORY_STANDARD.md — Reusable standard

Cleanup

  • Root docs moved to docs/ (ARCHITECTURE, RELEASE, VERSIONING, SUPPORT, ROADMAP, PRIVACY)
  • CONTRIBUTING.md points to docs/Contributing.md
  • Agent files updated with new doc paths
  • .gitignore updated
  • 56 files changed across the repository

Apply the Kovina Repository Standard to OpenReader, transforming the
repository into a product showcase for end users and recruiters.

### Repository Structure
- assets/ reorganized: hero/, screenshots/, icons/, branding/
- docs/ created: Architecture.md, Deployment.md, Testing.md, Contributing.md
- Root docs moved to docs/: RELEASE.md, VERSIONING.md, SUPPORT.md,
  ARCHITECTURE.md, ROADMAP.md, PRIVACY.md
- CONTRIBUTING.md updated to point to docs/Contributing.md
- .gitignore updated with .wrangler/ exclusion
- AGENTS.md and CLAUDE.md updated with new doc paths

### New Assets
- 12 Kovina-style feature SVG icons (48x48, 1.5px stroke)
- 8 tech stack SVG icons
- OpenReader app icon SVG
- All icons in assets/icons/ per standard

### README (11-section Kovina standard)
1. Hero — logo, tagline, large hero screenshot
2. Primary CTA — Store, Release, Website, Source Code badges
3. Gallery — Dark mode, PDF tools, about dialog, sample doc
4. Why OpenReader — 4 value propositions
5. Features — Two-column grid with Kovina SVG icons
6. Designed For — 5 audience segments
7. Design Philosophy — Quote + philosophy paragraph
8. Built With — Icon row (8 tech icons)
9. Version Journey — Timeline from v0.1.0 to v1.2.4
10. License — AGPLv3 + CTA badges
11. Part of the Open Collection — 9 Open* apps with links

### Standard Document
- docs/playbooks/KOVINA_REPOSITORY_STANDARD.md — reusable spec for all
  Kovina repositories covering structure, section order, assets, icons,
  and quality checklist

Co-Authored-By: Claude <noreply@anthropic.com>
@sparshsam sparshsam merged commit 4220da0 into main Jun 29, 2026
3 of 6 checks passed
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