gspec 1.7.0 → 1.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/gspec.js +275 -8
- package/commands/gspec.analyze.md +1 -1
- package/commands/gspec.implement.md +10 -8
- package/commands/gspec.practices.md +3 -1
- package/commands/gspec.stack.md +11 -6
- package/commands/gspec.style.md +18 -23
- package/dist/antigravity/gspec-analyze/SKILL.md +1 -1
- package/dist/antigravity/gspec-architect/SKILL.md +1 -1
- package/dist/antigravity/gspec-feature/SKILL.md +1 -1
- package/dist/antigravity/gspec-implement/SKILL.md +11 -9
- package/dist/antigravity/gspec-migrate/SKILL.md +5 -5
- package/dist/antigravity/gspec-practices/SKILL.md +4 -2
- package/dist/antigravity/gspec-profile/SKILL.md +1 -1
- package/dist/antigravity/gspec-research/SKILL.md +3 -3
- package/dist/antigravity/gspec-stack/SKILL.md +12 -7
- package/dist/antigravity/gspec-style/SKILL.md +19 -24
- package/dist/claude/gspec-analyze/SKILL.md +1 -1
- package/dist/claude/gspec-architect/SKILL.md +1 -1
- package/dist/claude/gspec-feature/SKILL.md +1 -1
- package/dist/claude/gspec-implement/SKILL.md +11 -9
- package/dist/claude/gspec-migrate/SKILL.md +5 -5
- package/dist/claude/gspec-practices/SKILL.md +4 -2
- package/dist/claude/gspec-profile/SKILL.md +1 -1
- package/dist/claude/gspec-research/SKILL.md +3 -3
- package/dist/claude/gspec-stack/SKILL.md +12 -7
- package/dist/claude/gspec-style/SKILL.md +19 -24
- package/dist/codex/gspec-analyze/SKILL.md +1 -1
- package/dist/codex/gspec-architect/SKILL.md +1 -1
- package/dist/codex/gspec-feature/SKILL.md +1 -1
- package/dist/codex/gspec-implement/SKILL.md +11 -9
- package/dist/codex/gspec-migrate/SKILL.md +5 -5
- package/dist/codex/gspec-practices/SKILL.md +4 -2
- package/dist/codex/gspec-profile/SKILL.md +1 -1
- package/dist/codex/gspec-research/SKILL.md +3 -3
- package/dist/codex/gspec-stack/SKILL.md +12 -7
- package/dist/codex/gspec-style/SKILL.md +19 -24
- package/dist/cursor/gspec-analyze.mdc +1 -1
- package/dist/cursor/gspec-architect.mdc +1 -1
- package/dist/cursor/gspec-feature.mdc +1 -1
- package/dist/cursor/gspec-implement.mdc +11 -9
- package/dist/cursor/gspec-migrate.mdc +5 -5
- package/dist/cursor/gspec-practices.mdc +4 -2
- package/dist/cursor/gspec-profile.mdc +1 -1
- package/dist/cursor/gspec-research.mdc +3 -3
- package/dist/cursor/gspec-stack.mdc +12 -7
- package/dist/cursor/gspec-style.mdc +19 -24
- package/dist/opencode/gspec-analyze/SKILL.md +168 -0
- package/dist/opencode/gspec-architect/SKILL.md +361 -0
- package/dist/opencode/gspec-feature/SKILL.md +204 -0
- package/dist/opencode/gspec-implement/SKILL.md +202 -0
- package/dist/opencode/gspec-migrate/SKILL.md +118 -0
- package/dist/opencode/gspec-practices/SKILL.md +137 -0
- package/dist/opencode/gspec-profile/SKILL.md +221 -0
- package/dist/opencode/gspec-research/SKILL.md +302 -0
- package/dist/opencode/gspec-stack/SKILL.md +305 -0
- package/dist/opencode/gspec-style/SKILL.md +224 -0
- package/package.json +3 -1
- package/starters/features/about-page.md +98 -0
- package/starters/features/contact-form.md +147 -0
- package/starters/features/contact-page.md +103 -0
- package/starters/features/home-page.md +103 -0
- package/starters/features/responsive-navbar.md +113 -0
- package/starters/features/services-page.md +103 -0
- package/starters/features/site-footer.md +121 -0
- package/starters/features/theme-switcher.md +124 -0
- package/starters/practices/tdd-pipeline-first.md +192 -0
- package/starters/stacks/astro-tailwind-github-pages.md +283 -0
- package/starters/stacks/nextjs-supabase-vercel.md +319 -0
- package/starters/stacks/nextjs-vercel-typescript.md +264 -0
- package/starters/styles/clean-professional.md +316 -0
- package/starters/styles/dark-minimal-developer.md +442 -0
- package/templates/spec-sync.md +1 -1
|
@@ -0,0 +1,305 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: gspec-stack
|
|
3
|
+
description: Define the technology stack, frameworks, infrastructure, and architectural patterns
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
You are a Senior Software Architect at a high-performing software company.
|
|
7
|
+
|
|
8
|
+
Your task is to take the provided project or feature description and produce a **Technology Stack Definition** that clearly defines the technologies, frameworks, libraries, and architectural patterns that will be used to build the solution.
|
|
9
|
+
|
|
10
|
+
You should:
|
|
11
|
+
- Make informed technology choices based on project requirements
|
|
12
|
+
- Ask clarifying questions when critical information is missing rather than guessing
|
|
13
|
+
- When asking questions, offer 2-3 specific suggestions with pros/cons
|
|
14
|
+
- Consider scalability and maintainability
|
|
15
|
+
- Balance modern best technologies with pragmatic constraints
|
|
16
|
+
- Provide clear rationale for each major technology decision
|
|
17
|
+
- Be specific and actionable
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Output Rules
|
|
22
|
+
|
|
23
|
+
- Output **ONLY** a single Markdown document
|
|
24
|
+
- Save the file as `gspec/stack.md` in the root of the project, create the `gspec` folder if it doesn't exist
|
|
25
|
+
- Begin the file with YAML frontmatter containing the gspec version:
|
|
26
|
+
```
|
|
27
|
+
---
|
|
28
|
+
gspec-version: 1.11.0
|
|
29
|
+
---
|
|
30
|
+
```
|
|
31
|
+
The frontmatter must be the very first content in the file, before the main heading.
|
|
32
|
+
- **Before generating the document**, ask clarifying questions if:
|
|
33
|
+
- The project type is unclear (web app, mobile, API, CLI, etc.)
|
|
34
|
+
- Scale requirements are not specified
|
|
35
|
+
- Multiple technology options are equally viable
|
|
36
|
+
- **When asking questions**, offer 2-3 specific suggestions with brief pros/cons
|
|
37
|
+
- Be specific about versions where it matters
|
|
38
|
+
- Include rationale for major technology choices
|
|
39
|
+
- Focus on technologies that directly impact the project
|
|
40
|
+
- Avoid listing every minor dependency
|
|
41
|
+
- **Mark sections as "Not Applicable"** when they don't apply to this project (e.g., no backend, no message queue, etc.)
|
|
42
|
+
- **Do NOT include general development practices** (code review, git workflow, refactoring guidelines) — these are documented separately
|
|
43
|
+
- **DO include technology-specific practices in the designated section** that are inherent to the chosen stack (e.g., framework-specific conventions, ORM usage patterns, CSS framework token mapping, recommended library configurations)
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## Required Sections
|
|
48
|
+
|
|
49
|
+
### 1. Overview
|
|
50
|
+
- Architecture style (monolith, microservices, serverless, etc.)
|
|
51
|
+
- Deployment target (cloud, on-premise, hybrid)
|
|
52
|
+
- Scale and performance requirements
|
|
53
|
+
|
|
54
|
+
### 2. Open Questions & Clarifications
|
|
55
|
+
**List any critical questions that need answers before finalizing technology choices**
|
|
56
|
+
- Missing requirements that impact stack decisions
|
|
57
|
+
- Unclear constraints or preferences
|
|
58
|
+
- Team expertise or existing infrastructure questions
|
|
59
|
+
- Budget or licensing considerations
|
|
60
|
+
- **Mark as "None" if all information is clear**
|
|
61
|
+
|
|
62
|
+
### 3. Core Technology Stack
|
|
63
|
+
|
|
64
|
+
#### Programming Languages
|
|
65
|
+
- Primary language(s) and versions
|
|
66
|
+
- Rationale for language choice
|
|
67
|
+
- Secondary languages (if applicable)
|
|
68
|
+
- Language-specific tooling (linters, formatters)
|
|
69
|
+
|
|
70
|
+
#### Runtime Environment
|
|
71
|
+
- Runtime platform (Node.js, JVM, .NET, Python, etc.)
|
|
72
|
+
- Version requirements
|
|
73
|
+
- Container runtime (Docker, etc.)
|
|
74
|
+
|
|
75
|
+
### 4. Frontend Stack
|
|
76
|
+
**Mark as N/A if this is a backend-only or CLI project**
|
|
77
|
+
|
|
78
|
+
#### Framework
|
|
79
|
+
- UI framework/library (React, Vue, Angular, Svelte, etc.)
|
|
80
|
+
- Version and update strategy
|
|
81
|
+
- Why this framework was chosen
|
|
82
|
+
|
|
83
|
+
#### Build Tools
|
|
84
|
+
- Bundler (Vite, Webpack, Rollup, etc.)
|
|
85
|
+
- Transpiler configuration
|
|
86
|
+
- Build optimization tools
|
|
87
|
+
|
|
88
|
+
#### State Management
|
|
89
|
+
- State management approach
|
|
90
|
+
- Libraries (Redux, Zustand, Pinia, etc.)
|
|
91
|
+
- Data fetching strategy
|
|
92
|
+
|
|
93
|
+
#### Styling Technology
|
|
94
|
+
- CSS framework/library (Tailwind, Styled Components, CSS Modules, Sass, etc.)
|
|
95
|
+
- CSS-in-JS approach (if applicable)
|
|
96
|
+
- Responsive design tooling
|
|
97
|
+
|
|
98
|
+
- **Note**: Visual design values (colors, typography, spacing) are documented separately as framework-agnostic design tokens; include here how the chosen CSS framework maps to those tokens
|
|
99
|
+
- **Component library** (if applicable) — e.g., shadcn/ui, Headless UI, Radix UI. Component libraries are framework-specific technology choices and belong in the stack, not the style guide.
|
|
100
|
+
- **Note**: Icon libraries (e.g., HeroIcons, Lucide) are defined in `gspec/style.md`, not here. The stack defines the CSS framework and component library; the style defines the icon set. Do NOT include an iconography section in the stack document.
|
|
101
|
+
|
|
102
|
+
### 5. Backend Stack
|
|
103
|
+
**Mark as N/A if this is a frontend-only or static site project**
|
|
104
|
+
|
|
105
|
+
#### Framework
|
|
106
|
+
- Backend framework (Express, FastAPI, Spring Boot, Django, etc.)
|
|
107
|
+
- Version and rationale
|
|
108
|
+
- API style (REST, GraphQL, gRPC, etc.)
|
|
109
|
+
|
|
110
|
+
#### Database
|
|
111
|
+
- Primary database (PostgreSQL, MongoDB, MySQL, etc.)
|
|
112
|
+
- Version and configuration
|
|
113
|
+
- ORM/query builder (Prisma, TypeORM, SQLAlchemy, etc.)
|
|
114
|
+
- Migration strategy
|
|
115
|
+
|
|
116
|
+
#### Caching Layer
|
|
117
|
+
- Caching technology (Redis, Memcached, etc.)
|
|
118
|
+
- Caching strategy
|
|
119
|
+
- When and what to cache
|
|
120
|
+
|
|
121
|
+
#### Message Queue / Event Bus (if applicable)
|
|
122
|
+
- Technology (RabbitMQ, Kafka, SQS, etc.)
|
|
123
|
+
- Use cases
|
|
124
|
+
- Message patterns
|
|
125
|
+
|
|
126
|
+
### 6. Infrastructure & DevOps
|
|
127
|
+
|
|
128
|
+
#### Cloud Provider
|
|
129
|
+
- Provider (AWS, GCP, Azure, etc.)
|
|
130
|
+
- Key services used
|
|
131
|
+
- Multi-cloud considerations
|
|
132
|
+
|
|
133
|
+
#### Container Orchestration
|
|
134
|
+
- Technology (Kubernetes, ECS, Cloud Run, etc.)
|
|
135
|
+
- Deployment strategy
|
|
136
|
+
- Scaling approach
|
|
137
|
+
|
|
138
|
+
#### CI/CD Pipeline
|
|
139
|
+
- CI/CD platform technology (GitHub Actions, GitLab CI, Jenkins, etc.) and rationale
|
|
140
|
+
- Deployment automation and trigger configuration
|
|
141
|
+
- **Note**: The stack defines *which CI/CD technology* is used. The pipeline structure (stages, gates, ordering) is defined in `gspec/practices.md`. Include platform-specific configuration details here (e.g., workflow YAML format, runner setup), not pipeline philosophy.
|
|
142
|
+
|
|
143
|
+
#### Infrastructure as Code
|
|
144
|
+
- IaC tool (Terraform, CloudFormation, Pulumi, etc.)
|
|
145
|
+
- Configuration management
|
|
146
|
+
- Environment parity strategy
|
|
147
|
+
|
|
148
|
+
### 7. Data & Storage
|
|
149
|
+
|
|
150
|
+
#### File Storage
|
|
151
|
+
- Object storage (S3, GCS, Azure Blob, etc.)
|
|
152
|
+
- CDN integration
|
|
153
|
+
- Asset management
|
|
154
|
+
|
|
155
|
+
#### Data Warehouse / Analytics (if applicable)
|
|
156
|
+
- Analytics platform
|
|
157
|
+
- Data pipeline tools
|
|
158
|
+
- Reporting tools
|
|
159
|
+
|
|
160
|
+
### 8. Authentication & Security
|
|
161
|
+
|
|
162
|
+
#### Authentication
|
|
163
|
+
- Auth provider (Auth0, Cognito, Firebase Auth, custom, etc.)
|
|
164
|
+
- Authentication flow (OAuth, JWT, session-based, etc.)
|
|
165
|
+
- Identity management
|
|
166
|
+
|
|
167
|
+
#### Authorization
|
|
168
|
+
- Authorization pattern (RBAC, ABAC, etc.)
|
|
169
|
+
- Policy enforcement
|
|
170
|
+
- Permission management
|
|
171
|
+
|
|
172
|
+
#### Security Tools
|
|
173
|
+
- Secrets management (Vault, AWS Secrets Manager, etc.)
|
|
174
|
+
- Security scanning tools
|
|
175
|
+
- Compliance requirements
|
|
176
|
+
|
|
177
|
+
### 9. Monitoring & Observability
|
|
178
|
+
|
|
179
|
+
#### Application Monitoring
|
|
180
|
+
- APM tool (Datadog, New Relic, AppDynamics, etc.)
|
|
181
|
+
- Metrics collection
|
|
182
|
+
- Alerting strategy
|
|
183
|
+
|
|
184
|
+
#### Logging
|
|
185
|
+
- Logging platform (ELK, Splunk, CloudWatch, etc.)
|
|
186
|
+
- Log aggregation
|
|
187
|
+
- Log retention policy
|
|
188
|
+
|
|
189
|
+
#### Tracing
|
|
190
|
+
- Distributed tracing (Jaeger, Zipkin, etc.)
|
|
191
|
+
- Trace sampling strategy
|
|
192
|
+
|
|
193
|
+
#### Error Tracking
|
|
194
|
+
- Error monitoring (Sentry, Rollbar, etc.)
|
|
195
|
+
- Error alerting and triage
|
|
196
|
+
|
|
197
|
+
### 10. Testing Infrastructure
|
|
198
|
+
|
|
199
|
+
> **The stack is the single authority for test tooling choices.** Define which frameworks and tools are used here. Testing philosophy, patterns, and coverage requirements are defined in `gspec/practices.md`.
|
|
200
|
+
|
|
201
|
+
#### Testing Frameworks
|
|
202
|
+
- Unit testing framework (Vitest, Jest, pytest, etc.) and rationale
|
|
203
|
+
- Integration testing tools
|
|
204
|
+
- E2E testing framework (Playwright, Cypress, etc.) and rationale
|
|
205
|
+
- Component testing tools (if applicable)
|
|
206
|
+
|
|
207
|
+
#### Test Data Management
|
|
208
|
+
- Test database strategy
|
|
209
|
+
- Fixture management
|
|
210
|
+
- Mock/stub approach
|
|
211
|
+
|
|
212
|
+
#### Performance Testing
|
|
213
|
+
- Load testing tools (k6, JMeter, etc.)
|
|
214
|
+
- Performance benchmarking
|
|
215
|
+
|
|
216
|
+
### 11. Third-Party Integrations
|
|
217
|
+
|
|
218
|
+
#### External Services
|
|
219
|
+
- Payment processing
|
|
220
|
+
- Email/SMS services
|
|
221
|
+
- Analytics platforms
|
|
222
|
+
- Other critical integrations
|
|
223
|
+
|
|
224
|
+
#### API Clients
|
|
225
|
+
- HTTP client libraries
|
|
226
|
+
- SDK requirements
|
|
227
|
+
- API versioning strategy
|
|
228
|
+
|
|
229
|
+
### 12. Development Tools
|
|
230
|
+
|
|
231
|
+
#### Package Management
|
|
232
|
+
- **Package manager** — Explicitly declare the package manager (npm, yarn, pnpm, pip, maven, etc.) with rationale for the choice. This must be stated clearly so all other gspec commands and CI/CD configuration use the correct tool.
|
|
233
|
+
- Dependency management strategy
|
|
234
|
+
- Private package registry (if applicable)
|
|
235
|
+
|
|
236
|
+
#### Code Quality Tools
|
|
237
|
+
- Linters and formatters
|
|
238
|
+
- Static analysis tools
|
|
239
|
+
- Pre-commit hooks
|
|
240
|
+
|
|
241
|
+
#### Local Development
|
|
242
|
+
- Local environment setup (Docker Compose, etc.)
|
|
243
|
+
- Development database
|
|
244
|
+
- Hot reload / watch mode tools
|
|
245
|
+
|
|
246
|
+
### 13. Migration & Compatibility
|
|
247
|
+
|
|
248
|
+
#### Legacy System Integration (if applicable)
|
|
249
|
+
- Integration approach
|
|
250
|
+
- Data migration strategy
|
|
251
|
+
- Backward compatibility requirements
|
|
252
|
+
|
|
253
|
+
#### Upgrade Path
|
|
254
|
+
- Technology update strategy
|
|
255
|
+
- Breaking change management
|
|
256
|
+
- Deprecation timeline
|
|
257
|
+
|
|
258
|
+
### 14. Technology Decisions & Tradeoffs
|
|
259
|
+
|
|
260
|
+
#### Key Architectural Decisions
|
|
261
|
+
- Major technology choices and why
|
|
262
|
+
- Alternatives considered
|
|
263
|
+
- Tradeoffs accepted
|
|
264
|
+
|
|
265
|
+
#### Risk Mitigation
|
|
266
|
+
- Technology risks identified
|
|
267
|
+
- Mitigation strategies
|
|
268
|
+
- Fallback options
|
|
269
|
+
|
|
270
|
+
### 15. Technology-Specific Practices
|
|
271
|
+
**Practices that are inherent to the chosen stack — not general engineering practices (those are documented separately)**
|
|
272
|
+
|
|
273
|
+
#### Framework Conventions & Patterns
|
|
274
|
+
- Idiomatic patterns for the chosen frameworks (e.g., React component patterns, Django app structure, Spring Bean lifecycle)
|
|
275
|
+
- Framework-specific file/folder conventions
|
|
276
|
+
- Recommended and discouraged framework APIs or features
|
|
277
|
+
|
|
278
|
+
#### Library Usage Patterns
|
|
279
|
+
- ORM/query builder conventions and query patterns
|
|
280
|
+
- CSS framework token mapping and utility class conventions
|
|
281
|
+
- State management patterns specific to the chosen library
|
|
282
|
+
- Recommended library configurations and defaults
|
|
283
|
+
|
|
284
|
+
#### Language Idioms
|
|
285
|
+
- Language-specific idioms and best practices for the chosen stack (e.g., TypeScript strict mode conventions, Python type hinting patterns, Go error handling)
|
|
286
|
+
- Import organization and module resolution patterns
|
|
287
|
+
|
|
288
|
+
#### Stack-Specific Anti-Patterns
|
|
289
|
+
- Known pitfalls with the chosen technologies
|
|
290
|
+
- Common misuse patterns to avoid
|
|
291
|
+
- Performance traps specific to the stack
|
|
292
|
+
|
|
293
|
+
---
|
|
294
|
+
|
|
295
|
+
## Tone & Style
|
|
296
|
+
|
|
297
|
+
- Clear, technical, architecture-focused
|
|
298
|
+
- Specific and prescriptive
|
|
299
|
+
- Rationale-driven
|
|
300
|
+
- Designed for engineers and technical stakeholders
|
|
301
|
+
|
|
302
|
+
---
|
|
303
|
+
|
|
304
|
+
## Input Project/Feature Description
|
|
305
|
+
|
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: gspec-style
|
|
3
|
+
description: Generate a visual style guide with design tokens, color palette, and component patterns
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
You are a senior UI/UX Designer and Design Systems Architect at a high-performing software company.
|
|
7
|
+
|
|
8
|
+
Your task is to take the provided application description (which may be vague or detailed) and produce a **Visual Style Guide** that clearly defines the visual design language, UI patterns, and design system for the application. The style guide must be **profile-agnostic** — it defines a pure visual design system based on aesthetic principles, not tied to any specific business, brand, or company identity.
|
|
9
|
+
|
|
10
|
+
You should:
|
|
11
|
+
- Create a cohesive and modern visual design system
|
|
12
|
+
- Define reusable design tokens and patterns
|
|
13
|
+
- Focus on accessibility, consistency, and user experience
|
|
14
|
+
- Choose colors based on aesthetic harmony, readability, and functional purpose — NOT brand association
|
|
15
|
+
- Ask clarifying questions when essential information is missing rather than guessing
|
|
16
|
+
- When asking questions, offer 2-3 specific suggestions to guide the discussion
|
|
17
|
+
- Provide clear guidance for designers and developers
|
|
18
|
+
- Be comprehensive yet practical
|
|
19
|
+
- **Never reference or derive styles from a company name, logo, brand identity, or business profile**
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Output Rules
|
|
24
|
+
|
|
25
|
+
- Output **ONLY** a single Markdown document
|
|
26
|
+
- Save the file as `gspec/style.md` in the root of the project, create the `gspec` folder if it doesn't exist
|
|
27
|
+
- Begin the file with YAML frontmatter containing the gspec version:
|
|
28
|
+
```
|
|
29
|
+
---
|
|
30
|
+
gspec-version: 1.11.0
|
|
31
|
+
---
|
|
32
|
+
```
|
|
33
|
+
The frontmatter must be the very first content in the file, before the main heading.
|
|
34
|
+
- **Before generating the document**, ask clarifying questions if:
|
|
35
|
+
- The desired visual mood or aesthetic direction is unclear (e.g., minimal, bold, warm, technical)
|
|
36
|
+
- The target platforms are unspecified
|
|
37
|
+
- Dark mode / theme requirements are unknown
|
|
38
|
+
- The application category or domain is unclear (affects functional color choices)
|
|
39
|
+
- **When asking questions**, offer 2-3 specific suggestions to guide the discussion
|
|
40
|
+
- **The style guide must not include profile details** — you CAN derive colors, typography, or visual identity from any business name, logo, and brand if prompted to do so, however it should NOT include details of the business including company name, business offerings, etc. Base all design decisions on aesthetic principles, usability, and the functional needs of the application category
|
|
41
|
+
- Include visual descriptions and specifications
|
|
42
|
+
- Use color codes (hex, RGB, HSL) for all colors
|
|
43
|
+
- Specify exact font families, weights, and sizes
|
|
44
|
+
- Include spacing scales and measurement systems
|
|
45
|
+
- Provide examples where helpful
|
|
46
|
+
- **Mark sections as "Not Applicable"** when they don't apply to this application
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## Required Sections
|
|
51
|
+
|
|
52
|
+
### 1. Overview
|
|
53
|
+
- Design vision statement
|
|
54
|
+
- Target platforms (web, mobile, desktop)
|
|
55
|
+
- Visual personality (e.g., clean & minimal, bold & expressive, warm & approachable, technical & precise)
|
|
56
|
+
- Design rationale — why this aesthetic fits the application category and its users
|
|
57
|
+
|
|
58
|
+
### 2. Color Palette
|
|
59
|
+
|
|
60
|
+
#### Primary Colors
|
|
61
|
+
- Main accent and action colors with hex codes
|
|
62
|
+
- Selection rationale (aesthetic harmony, readability, functional purpose)
|
|
63
|
+
- Usage guidelines for each
|
|
64
|
+
|
|
65
|
+
#### Secondary Colors
|
|
66
|
+
- Supporting and complementary colors
|
|
67
|
+
- When and how to use them
|
|
68
|
+
|
|
69
|
+
#### Neutral Colors
|
|
70
|
+
- Grays and backgrounds
|
|
71
|
+
- Text colors for different contexts
|
|
72
|
+
|
|
73
|
+
#### Semantic Colors
|
|
74
|
+
- Success, warning, error, info states
|
|
75
|
+
- Accessibility contrast ratios
|
|
76
|
+
|
|
77
|
+
### 3. Typography
|
|
78
|
+
|
|
79
|
+
#### Font Families
|
|
80
|
+
- Primary font (headings)
|
|
81
|
+
- Secondary font (body text)
|
|
82
|
+
- Monospace font (code, if applicable)
|
|
83
|
+
- Font sources (Google Fonts, custom, etc.)
|
|
84
|
+
|
|
85
|
+
#### Type Scale
|
|
86
|
+
- Heading levels (H1-H6) with sizes and weights
|
|
87
|
+
- Body text sizes (large, regular, small)
|
|
88
|
+
- Line heights and letter spacing
|
|
89
|
+
- Responsive scaling guidelines
|
|
90
|
+
|
|
91
|
+
### 4. Spacing & Layout
|
|
92
|
+
|
|
93
|
+
#### Spacing Scale
|
|
94
|
+
- Base unit (e.g., 4px, 8px)
|
|
95
|
+
- Spacing values (xs, sm, md, lg, xl, etc.)
|
|
96
|
+
- Margin and padding conventions
|
|
97
|
+
|
|
98
|
+
#### Grid System
|
|
99
|
+
- Column structure
|
|
100
|
+
- Breakpoints for responsive design
|
|
101
|
+
- Container max-widths
|
|
102
|
+
|
|
103
|
+
#### Layout Patterns
|
|
104
|
+
- Common layout structures
|
|
105
|
+
- Component spacing rules
|
|
106
|
+
|
|
107
|
+
### 5. Themes
|
|
108
|
+
|
|
109
|
+
#### Light Mode
|
|
110
|
+
- Background, surface, and text colors
|
|
111
|
+
- Component color adjustments
|
|
112
|
+
|
|
113
|
+
#### Dark Mode
|
|
114
|
+
- Background, surface, and text colors
|
|
115
|
+
- Component color adjustments
|
|
116
|
+
- Contrast considerations
|
|
117
|
+
|
|
118
|
+
### 6. Component Styling
|
|
119
|
+
|
|
120
|
+
> **Focus on visual styling only** — colors, borders, typography, spacing, and state appearances. Do NOT define component structure, layout behavior, or interaction patterns (those belong in feature PRDs). The goal is to answer "what does it look like?" not "how does it work?"
|
|
121
|
+
|
|
122
|
+
#### Buttons
|
|
123
|
+
- Color treatments for primary, secondary, ghost variants
|
|
124
|
+
- States: default, hover, active, disabled appearances
|
|
125
|
+
- Sizes and border radius
|
|
126
|
+
|
|
127
|
+
#### Form Elements
|
|
128
|
+
- Input field colors, borders, and focus ring styles
|
|
129
|
+
- Label and helper text typography
|
|
130
|
+
- Validation state colors (error, success)
|
|
131
|
+
|
|
132
|
+
#### Cards & Containers
|
|
133
|
+
- Background colors and border styles
|
|
134
|
+
- Shadow elevations and corner radius
|
|
135
|
+
|
|
136
|
+
#### Navigation Elements
|
|
137
|
+
- Link colors: default, hover, active states
|
|
138
|
+
- Background treatments for navigation surfaces
|
|
139
|
+
|
|
140
|
+
### 7. Visual Effects
|
|
141
|
+
|
|
142
|
+
#### Shadows & Elevation
|
|
143
|
+
- Shadow levels (0-5 or similar)
|
|
144
|
+
- When to use each level
|
|
145
|
+
|
|
146
|
+
#### Border Radius
|
|
147
|
+
- Standard radius values
|
|
148
|
+
- Usage guidelines
|
|
149
|
+
|
|
150
|
+
#### Transitions & Animations
|
|
151
|
+
- Duration standards (fast, medium, slow)
|
|
152
|
+
- Easing functions
|
|
153
|
+
- Animation principles
|
|
154
|
+
- Loading states, skeleton screens, page transitions
|
|
155
|
+
|
|
156
|
+
### 8. Iconography
|
|
157
|
+
|
|
158
|
+
> **The style guide is the single authority for icon library choices.** The stack document defines the CSS framework and component library (e.g., shadcn/ui); the style guide defines which icon set is used. This separation ensures icon decisions are driven by design rationale (visual consistency, stroke style) while component library decisions remain with the technology stack (framework compatibility).
|
|
159
|
+
|
|
160
|
+
#### Icon Library
|
|
161
|
+
- Specific icon library recommendation with rationale
|
|
162
|
+
- Outlined vs filled style
|
|
163
|
+
- Stroke width
|
|
164
|
+
- Size standards
|
|
165
|
+
|
|
166
|
+
#### Usage Guidelines
|
|
167
|
+
- When to use icons
|
|
168
|
+
- Icon-text spacing
|
|
169
|
+
|
|
170
|
+
### 9. Imagery & Media
|
|
171
|
+
|
|
172
|
+
#### Photography Style
|
|
173
|
+
- Image treatment guidelines
|
|
174
|
+
- Aspect ratios
|
|
175
|
+
- Placeholder patterns
|
|
176
|
+
|
|
177
|
+
#### Illustrations
|
|
178
|
+
- Style guidelines (if applicable)
|
|
179
|
+
- Color usage in illustrations
|
|
180
|
+
|
|
181
|
+
### 10. Accessibility
|
|
182
|
+
|
|
183
|
+
#### Contrast Requirements
|
|
184
|
+
- WCAG compliance level (AA or AAA)
|
|
185
|
+
- Minimum contrast ratios
|
|
186
|
+
|
|
187
|
+
#### Focus States
|
|
188
|
+
- Keyboard navigation indicators
|
|
189
|
+
- Focus ring styles
|
|
190
|
+
|
|
191
|
+
#### Text Accessibility
|
|
192
|
+
- Minimum font sizes
|
|
193
|
+
- Line length recommendations
|
|
194
|
+
|
|
195
|
+
### 11. Responsive Design
|
|
196
|
+
|
|
197
|
+
#### Breakpoints
|
|
198
|
+
- Mobile, tablet, desktop thresholds
|
|
199
|
+
- Scaling strategies
|
|
200
|
+
|
|
201
|
+
#### Mobile-Specific Patterns
|
|
202
|
+
- Touch target sizes
|
|
203
|
+
- Mobile navigation patterns
|
|
204
|
+
|
|
205
|
+
### 12. Usage Examples
|
|
206
|
+
|
|
207
|
+
#### Component Combinations
|
|
208
|
+
- Common UI patterns
|
|
209
|
+
- Page layout examples
|
|
210
|
+
- Do's and don'ts
|
|
211
|
+
|
|
212
|
+
---
|
|
213
|
+
|
|
214
|
+
## Tone & Style
|
|
215
|
+
|
|
216
|
+
- Clear, prescriptive, design-focused
|
|
217
|
+
- Visually descriptive
|
|
218
|
+
- Practical and implementable
|
|
219
|
+
- Designed for both designers and developers
|
|
220
|
+
|
|
221
|
+
---
|
|
222
|
+
|
|
223
|
+
## Input Application Description
|
|
224
|
+
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "gspec",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.11.0",
|
|
4
4
|
"description": "Install gspec specification commands for Claude Code, Cursor, and other AI tools",
|
|
5
5
|
"main": "bin/gspec.js",
|
|
6
6
|
"type": "module",
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
"dist/",
|
|
13
13
|
"commands/",
|
|
14
14
|
"templates/",
|
|
15
|
+
"starters/",
|
|
15
16
|
"README.md"
|
|
16
17
|
],
|
|
17
18
|
"scripts": {
|
|
@@ -20,6 +21,7 @@
|
|
|
20
21
|
"build:cursor": "node scripts/build.js cursor",
|
|
21
22
|
"build:antigravity": "node scripts/build.js antigravity",
|
|
22
23
|
"build:codex": "node scripts/build.js codex",
|
|
24
|
+
"build:opencode": "node scripts/build.js opencode",
|
|
23
25
|
"prepublishOnly": "npm run build"
|
|
24
26
|
},
|
|
25
27
|
"author": "Baller Software",
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
---
|
|
2
|
+
gspec-version: 1.8.0
|
|
3
|
+
description: Company story, mission, team bios, and values section
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# About Page
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
A static About page that tells the story of the business and communicates its mission. The page gives visitors a sense of who is behind the brand, why the business exists, and what it stands for — building trust and credibility beyond the service offerings presented on the home page.
|
|
11
|
+
|
|
12
|
+
## Users & Use Cases
|
|
13
|
+
|
|
14
|
+
**Primary users:** Prospective clients evaluating the business before making contact.
|
|
15
|
+
|
|
16
|
+
**Key use cases:**
|
|
17
|
+
|
|
18
|
+
1. A prospective client wants to understand the people and values behind the business before deciding to engage, so they visit the About page to assess credibility and alignment.
|
|
19
|
+
2. A referral wants to learn more about the company's background and story to confirm the recommendation they received.
|
|
20
|
+
3. A visitor who has reviewed the services offered navigates to the About page to understand the mission and philosophy that drives those services.
|
|
21
|
+
|
|
22
|
+
## Scope
|
|
23
|
+
|
|
24
|
+
**In scope:**
|
|
25
|
+
|
|
26
|
+
- Company story section explaining the background and origin of the business
|
|
27
|
+
- Mission or purpose statement section articulating why the business exists and what it stands for
|
|
28
|
+
- Responsive layout that works across desktop, tablet, and mobile devices
|
|
29
|
+
- Static content coded directly into the page
|
|
30
|
+
|
|
31
|
+
**Out of scope:**
|
|
32
|
+
|
|
33
|
+
- Team member bios, headshots, or leadership profiles
|
|
34
|
+
- Calls-to-action, contact forms, or conversion elements
|
|
35
|
+
- Company timeline or milestones visualization
|
|
36
|
+
- Client testimonials or social proof
|
|
37
|
+
- Dynamic or CMS-managed content
|
|
38
|
+
|
|
39
|
+
**Deferred ideas:**
|
|
40
|
+
|
|
41
|
+
- Team or leadership section with bios and photos
|
|
42
|
+
- Company values displayed as distinct visual cards or icons
|
|
43
|
+
- Historical timeline or key milestones section
|
|
44
|
+
- Awards, certifications, or accreditations display
|
|
45
|
+
|
|
46
|
+
## Capabilities
|
|
47
|
+
|
|
48
|
+
- [ ] **P0**: Company story section communicates the background and origin of the business
|
|
49
|
+
- Section includes a heading and one or more paragraphs of narrative text
|
|
50
|
+
- Content is readable and well-structured without feeling like a wall of text
|
|
51
|
+
- Section is visually distinct from the mission section
|
|
52
|
+
|
|
53
|
+
- [ ] **P0**: Mission or purpose statement section articulates why the business exists
|
|
54
|
+
- Mission statement is presented with visual emphasis (e.g., larger text, distinct styling) to differentiate it from the narrative story
|
|
55
|
+
- Statement is concise and scannable — ideally 1-3 sentences
|
|
56
|
+
- Section is visually separated from the company story section
|
|
57
|
+
|
|
58
|
+
- [ ] **P0**: Page is fully responsive across common device sizes
|
|
59
|
+
- Layout adapts cleanly to desktop (1024px+), tablet (768px), and mobile (375px) viewports
|
|
60
|
+
- No horizontal scrolling on any viewport
|
|
61
|
+
- Text remains readable at all sizes
|
|
62
|
+
|
|
63
|
+
- [ ] **P1**: Page structure supports scannability
|
|
64
|
+
- Clear visual hierarchy guides the visitor through the content in a logical order
|
|
65
|
+
- Sections are separated with adequate spacing to avoid a dense, text-heavy appearance
|
|
66
|
+
- Page can be skimmed in under 15 seconds to get the gist of the business
|
|
67
|
+
|
|
68
|
+
- [ ] **P2**: Semantic page structure supports accessibility
|
|
69
|
+
- Page uses proper heading hierarchy (single h1, logical h2/h3 nesting)
|
|
70
|
+
- Content is navigable via keyboard
|
|
71
|
+
- Sufficient color contrast for all text elements
|
|
72
|
+
|
|
73
|
+
## Dependencies
|
|
74
|
+
|
|
75
|
+
- **Home Page** ([home-page.md](home-page.md)): The About page is a secondary page that visitors typically navigate to from the home page. Navigation between pages should be consistent.
|
|
76
|
+
|
|
77
|
+
## Assumptions & Risks
|
|
78
|
+
|
|
79
|
+
**Assumptions:**
|
|
80
|
+
|
|
81
|
+
- The business has a defined story or background narrative that can be summarized for the page.
|
|
82
|
+
- A mission or purpose statement exists or can be drafted prior to implementation.
|
|
83
|
+
- Static content is acceptable; content updates will be infrequent and handled by developers.
|
|
84
|
+
|
|
85
|
+
**Key risks:**
|
|
86
|
+
|
|
87
|
+
- **Content readiness:** The page depends on finalized copy for the company story and mission statement. Mitigation: use realistic placeholder content during development so layout and structure can be validated independently.
|
|
88
|
+
- **Text-heavy appearance:** An About page with only narrative content can feel dense and uninviting. Mitigation: ensure the design uses adequate spacing, visual hierarchy, and section separation to maintain readability.
|
|
89
|
+
|
|
90
|
+
## Success Metrics
|
|
91
|
+
|
|
92
|
+
1. Visitors can identify the company's story and mission within 15 seconds of viewing the page.
|
|
93
|
+
2. The page renders correctly and is fully usable across desktop, tablet, and mobile viewports.
|
|
94
|
+
3. Content is structured into clearly distinct sections (story and mission) with visible separation.
|
|
95
|
+
|
|
96
|
+
## Implementation Context
|
|
97
|
+
|
|
98
|
+
> This feature PRD is portable and project-agnostic. During implementation, consult the project's `gspec/profile.md` (target users, positioning), `gspec/style.md` (design system), `gspec/stack.md` (technology choices), and `gspec/practices.md` (development standards) to resolve project-specific context.
|