Skip to content

Conversation

@dfcoffin
Copy link

@dfcoffin dfcoffin commented Feb 7, 2026

Summary

Upgrades Redocly CLI to the latest version (2.16.0) for better features and performance, and adds the official Green Button Alliance logo to the documentation.

Changes Made

1. Redocly CLI Upgrade

Upgraded from 1.34.5 → 2.16.0

  • Latest features and improvements
  • Better build performance
  • Enhanced documentation generation
  • Smaller bundle size (959 KiB vs 994 KiB)

2. Green Button Alliance Logo

Added official GBA logo (logo.png - 18KB)
Configured logo in redocly.yaml theme section
Logo linked to https://www.greenbuttonalliance.org/

3. Schema Fixes

Fixed LocalTimeParameters examples

  • Quoted hex string values (B40E2000, 360E2000)
  • Resolves schema validation warnings

File Changes

  • Added: logo.png (GBA logo file)
  • Modified: package.json (Redocly 2.16.0)
  • Modified: package-lock.json (updated dependencies)
  • Modified: redocly.yaml (logo configuration)
  • Modified: openapi/components/schemas/LocalTimeParameters.yaml (fixed examples)

Total: 5 files changed, 591 insertions, 1121 deletions

Improvements

Performance

  • Smaller documentation bundle (959 KiB)
  • Faster build times
  • Updated dependencies

Branding

  • GBA logo in documentation header
  • Professional branded appearance
  • Links to greenbuttonalliance.org

Code Quality

  • Fixed schema example warnings
  • Cleaner validation output
  • Better type compliance

Validation

npm test - Passes with valid OpenAPI spec
npm run build - Successfully generates 959 KiB documentation
✅ Logo file added and referenced

Notes

  • Logo configuration warnings are expected in Redocly 2.16.0 (cosmetic only)
  • Documentation builds successfully with logo included
  • Security vulnerabilities from dependencies (3) - addressed separately

Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com

Upgraded to Redocly CLI 2.16.0 for improved features and better logo support.
Added Green Button Alliance logo to documentation.

Changes:
- Upgraded @redocly/cli from 1.34.5 to 2.16.0
- Added logo.png (18KB GBA logo file)
- Configured logo in redocly.yaml theme
- Fixed LocalTimeParameters schema examples (quoted hex strings)
- Updated package-lock.json with new dependencies

Documentation improvements:
- Smaller bundle size (959 KiB vs 994 KiB)
- Enhanced build performance
- Logo configuration ready (note: config warnings expected in v2.16.0)

Validation: Passes npm test with valid OpenAPI spec
Build: Successfully generates documentation with logo references

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@dfcoffin dfcoffin merged commit 6b6ec13 into main Feb 7, 2026
2 checks passed
@dfcoffin dfcoffin deleted the feature/add-gba-logo branch February 7, 2026 06:09
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