Skip to content

pranavwani/design-spec-v1

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Voltmx Design Specs — Starter

A minimal Jekyll site + GitHub workflow for managing design specs.

Quick Start

  1. Copy this folder into a new GitHub repo.
  2. Enable Pages → Build from main (root).
  3. Use the homepage buttons to open Issue Forms.

Structure

  • _specs/<family>/<version>/ — one folder per version (e.g., flutter-sdk/v2)
  • index.html — homepage with tabs, search, and “show all versions” toggle
  • _layouts/spec.html — spec page with left sidebar + status banner
  • .github/workflows/validate-specs.yml — CI guardrails
  • Issue forms in .github/ISSUE_TEMPLATE/

Rules

  • Only one active version per family (CI-enforced).
  • Deprecated specs require deprecated_at & deprecation_reason.
  • Updates should bump updated_at and add a changelog entry.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •