Skip to content

Conversation

@tmosleyIII
Copy link
Contributor

This pull request introduces comprehensive documentation and design shaping work for a Stripe-inspired redesign of the Obsrvr docs. It adds detailed progress tracking, technical strategy, and scope definition using Shape Up methodology, alongside improvements to user guidance and navigation in the documentation. The changes are grouped into three main themes: project shaping and planning, documentation enhancements, and minor technical corrections.

Project Shaping & Planning

  • Added .shape/PROGRESS.md and .shape/README.md to track redesign progress, define scope, priorities, and next steps, and document the Shape Up process for the Stripe-inspired design cycle. [1] [2]
  • Added .shape/stripe-inspired-redesign.md to provide a detailed pitch, solution sketch, scope line (MUST HAVE/NICE TO HAVE/COULD HAVE), technical strategy, risk mitigation, and implementation plan for the redesign.

Documentation Enhancements

  • Improved user guidance in docs/flow/consumers/index.md by adding a contextual info box linking to the component registry, custom consumer guides, and pipeline examples, and enhanced the "Next Steps" section with direct links to relevant resources. [1] [2]
  • Added import for HelperBox to docs/flow/overview.md to support contextual sidebar sections as part of the NICE TO HAVE enhancements.

Minor Technical Corrections

  • Corrected endpoint naming in CLAUDE.md from Soroban RPC to Stellar RPC for mainnet and testnet URLs to ensure accuracy in documentation.

tmosleyIII and others added 9 commits November 28, 2025 10:07
Implemented comprehensive design system following Stripe's patterns:

✅ Typography & Spacing
- Complete CSS custom property system with Stripe color palette
- 8px base grid spacing system
- Typography scale matching Stripe (12px - 48px)
- Font smoothing and letter spacing

✅ Custom Homepage
- Stripe-style hero section with clear CTAs
- User pathway cards (Quick start, Gateway, Flow)
- Popular resources section
- Gradient CTA section
- Fully responsive design

✅ Enhanced Components
- Code blocks with Stripe navy background and polished styling
- Hover-visible copy buttons
- Tables with proper borders and shadows
- Cards with lift animation
- Buttons with proper states

✅ Dark Mode
- Complete dark mode support matching Stripe's approach
- Proper color contrast ratios
- Smooth theme transitions

✅ Accessibility
- Focus states with purple outline
- Skip links
- Reduced motion support
- ARIA compliance maintained

Files changed:
- src/css/custom.css (779 lines)
- src/pages/index.js (complete rewrite)
- src/pages/index.module.css (complete rewrite)

MUST HAVEs completed (3/5):
1. ✅ Typography & Spacing
2. ✅ Code Block Polish
3. ✅ Custom Homepage
4. ⏳ Enhanced Search Modal
5. ⏳ Horizontal Navigation

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Implemented horizontal mega-menu navigation with dropdown menus,
completing 4 of 5 MUST HAVE features. Made strategic scope cut of
search modal to NICE TO HAVE due to Node 18 constraints.

## Changes

### Navigation Enhancement
- Added Products dropdown (Overview, Gateway Services, Flow Pipelines)
- Added Documentation dropdown (Quick Start, Registry, Processors, Consumers)
- Added Resources dropdown (Console, Status, GitHub)
- Added Sign In link to navbar

### CSS Enhancements
- Dropdown menu styling with shadows and borders
- Dropdown hover states with purple accent
- Dropdown arrow rotation animation
- Mobile hamburger menu styling
- Mobile sidebar enhancements
- Responsive breakpoints for all screen sizes

### Test Updates
- Fixed navigation test expectations (h1 visibility check)
- Added final screenshots spec for Day 2 documentation
- All 24 tests passing

### Progress Update
- Updated PROGRESS.md with Day 2 completion
- Hill chart moved to 85% (right side - making it happen!)
- Search modal cut to NICE TO HAVE (Node version blocker)
- Time tracking: 19h used / 80h budget (well ahead of schedule)

## Files Modified
- docusaurus.config.js: Navigation structure (lines 67-145)
- src/css/custom.css: Dropdown & mobile styling (lines 280-356)
- tests/docs-smoke.spec.ts: Fixed navigation test (line 32)
- tests/final-screenshots.spec.ts: Day 2 screenshot capture
- .shape/PROGRESS.md: Complete Day 2 update

## Results
- ✅ All MUST HAVEs complete (4/5, 1 cut with rationale)
- ✅ All tests passing (24/24)
- ✅ Mobile responsive
- ✅ Dark mode support
- ✅ Stripe-quality navigation
- ✅ Ready to ship early!

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Implemented three high-impact NICE TO HAVE features to enhance
the Stripe-inspired design with contextual helpers and refined
dark mode aesthetics.

## Enhancements

### 1. Enhanced Footer
- Reorganized into 4 clear sections (Products, Developers, Resources, Company)
- Added comprehensive link structure (15+ useful links)
- Created custom footer badges ("Powered by Stellar", "Enterprise Ready")
- Responsive layout with mobile-first design
- Custom styling with proper spacing and typography

### 2. Contextual Helper Sections
- Created reusable HelperBox component for documentation
- Stripe-inspired "Just getting started?" callout boxes
- Multiple variants (default, info, success, warning, tip)
- Added to Flow Overview page (quickstart helper)
- Added to Registry Overview page (component navigation helper)
- Fully responsive and dark mode compatible

### 3. Dark Mode Polish
- Subtle glow effects on primary buttons (0-20px purple glow)
- Enhanced card depth with layered shadows
- Navbar with gradient and backdrop blur
- Enhanced dropdown shadows with purple accent
- Glowing active sidebar links
- Refined focus states with purple halos
- Enhanced table hover states
- Gradient footer background
- All effects use subtle purple (#818CF8) theming

## Files Modified
- docusaurus.config.js: Footer structure (lines 147-242)
- src/css/custom.css: Footer & dark mode styling (lines 709-769, 173-251)
- src/components/HelperBox.js: New reusable component
- src/components/HelperBox.module.css: Component styling
- docs/flow/overview.md: Added quickstart helper box
- docs/flow/registry/overview.md: Added navigation helper box

## Results
- ✅ Enhanced footer with 4 organized sections
- ✅ Reusable helper component for all docs
- ✅ Refined dark mode with subtle glow effects
- ✅ All 12 smoke tests passing
- ✅ Build successful
- ✅ Fully responsive
- ✅ Accessible focus states

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Updates Flow documentation to reflect new Launch Plan pricing model:

- Pricing page (pricing.md): Complete rewrite featuring $99/month
  Launch Plan with included allowances as primary offering
  - Added usage allowance table (storage, processing, queries, etc.)
  - Included 3 usage scenario examples (small, medium, high-volume)
  - Moved legacy per-minute pricing to secondary "Legacy" section
  - Added comprehensive FAQ (10 questions)
  - Integrated HelperBox components for better UX
  - Added cost optimization tips and comparison tables

- Overview page (overview.md): Updated pricing references
  - Changed "Pay-As-You-Go Pricing" to "Launch Plan Pricing"
  - Replaced $0.003/minute with $99/month + allowances
  - Updated pricing section to reference Launch Plan features
  - Maintained link to detailed pricing page

This aligns documentation with the Launch Plan implementation
in obsrvr-console, providing users with clear, predictable
pricing information.

🤖 Generated with Claude Code

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.

2 participants