ArtifactHub plugin installer is the only supported installation method.
Remove manual tarball, sidecar, and build-from-source install options
to align documentation with company policy.
Co-Authored-By: Paperclip <noreply@paperclip.ing>
- README: fix LICENSE link, remove dead doc links, update install
instructions, remove hardcoded version/bundle size/LOC metrics
- artifacthub-pkg.yml: fix appVersion 0.2.18 → 0.2.20, fix README
path, fix build-from-source cd path
- docs/README.md: trim to only reference files that actually exist
(was 160 lines of aspirational links, now 47 lines of real ones)
- CLAUDE.md: correct "no MUI imports" claim — code uses @mui/material
- headlamp-plugin-developer agent: match corrected MUI convention
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Updated artifacthub-repo.yml owner and email
- Updated all artifacthub-pkg.yml files (current and historical versions)
- Updated package.json author
- Updated README.md badge URLs
- Updated all version-specific metadata files
Part of organization migration from cpfarhood to privilegedescalation.
Removed marketing fluff:
- Replaced "Zero Trust Architecture" with factual "How It Works"
- Removed buzzwords and kept technical accuracy
- Simplified security explanation to be clear and honest
Added Artifact Hub README:
- Created README.md for v0.2.4 release directory
- Clean, professional documentation without marketing speak
- Focused on features, usage, and troubleshooting
- Will appear on Artifact Hub package page
Both READMEs now:
- Provide accurate technical information
- Avoid exaggerated claims
- Focus on what the plugin actually does
- Keep language straightforward and honest
Generated with [Claude Code](https://claude.ai/code)
via [Happy](https://happy.engineering)
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Happy <yesreply@happy.engineering>
Updated all documentation to reflect current state:
Version Updates:
- Updated root README.md from v0.2.0 to v0.2.4 in installation instructions
- Updated "Latest release" badge to v0.2.4
- Updated CHANGELOG.md with v0.2.1, 0.2.2, 0.2.3, and 0.2.4 entries
- Added version comparison links for all releases
URL Migrations:
- Fixed all GitHub badge URLs from cpfarhood to privilegedescalation org
- Updated plugin README.md repository URL placeholder
- Ensured all references use privilegedescalation/headlamp-sealed-secrets-plugin
Changelog Additions:
- v0.2.4: Icon loading fix (Material-UI → Iconify)
- v0.2.3: Superseded by v0.2.4 (checksum mismatch note)
- v0.2.2: SDK downgrade to fix React context errors
- v0.2.1: Removed invalid main field from package.json
All version numbers, checksums, and URLs are now consistent across:
- package.json: 0.2.4
- artifacthub-pkg.yml: 0.2.4
- README.md: 0.2.4
- CHANGELOG.md: 0.2.4
- GitHub releases: v0.2.4
Generated with [Claude Code](https://claude.ai/code)
via [Happy](https://happy.engineering)
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Happy <yesreply@happy.engineering>
Updated all GitHub URLs from cpfarhood to privilegedescalation organization:
- Repository URLs in package.json and Artifact Hub metadata
- Documentation links and references
- Git remote updated
No functional changes - this is purely an organizational migration.
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Happy <yesreply@happy.engineering>
Enhanced README.md with:
**Visual Improvements**:
- Added test coverage and TypeScript badges
- Zero Trust Security callout banner
- Better structured sections with tables and diagrams
- Real-world code examples
**Features Section**:
- Reorganized into Security, Developer Experience, Accessibility, Production
- Clearer categorization of capabilities
- Highlighted unique features (client-side crypto, RBAC-aware UI)
**Quick Start**:
- Step-by-step installation with time estimates
- Code blocks for easy copy-paste
- Clear verification steps
- Link to detailed tutorial
**Documentation Navigation**:
- Categorized by Getting Started, User Guides, Tutorials, Reference
- Direct links to most important docs
- Complete documentation index link
**Use Cases**:
- Table format with guide links
- Real-world YAML and bash examples
- Practical scenarios (GitOps, CI/CD, multi-env)
**Security Section**:
- Visual architecture diagram showing zero-trust flow
- Security features table with implementation details
- Threat model matrix with mitigation status
- Links to ADR 003 and security hardening guide
**Technical Details**:
- Code quality metrics table
- Technology stack overview
- Architecture highlights with ADR links
- Emphasis on type safety and testing
**Contributing**:
- Quick start command block for contributors
- Contribution areas table with "good first issue" guidance
- Pre-submission checklist
- Links to workflow and testing guides
**Issues & Support**:
- Tiered support approach (docs → search → community → report)
- Common issues quick reference table
- Clear next steps for users
**Links Section**:
- Organized by Project Resources and External Resources
- Added Discussions and kubeseal CLI links
- Star History encouragement
Total changes: ~200 lines enhanced/reorganized
Generated with [Claude Code](https://claude.ai/code)
via [Happy](https://happy.engineering)
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Happy <yesreply@happy.engineering>
Reorganize and consolidate documentation into structured `/docs` directory
for better navigation and maintainability.
New documentation structure:
- docs/README.md - Documentation hub with complete index
- docs/getting-started/ - Installation and quick start guides
- docs/development/ - Workflow and testing guides
- docs/archive/ - Archived PHASE_*.md completion summaries
Key changes:
- Created docs/ directory with 9 subdirectories
- Moved HEADLAMP_INSTALLATION.md → docs/getting-started/installation.md (streamlined)
- Created docs/getting-started/quick-start.md (5-minute tutorial)
- Moved DEVELOPMENT.md → docs/development/workflow.md
- Moved TESTING_GUIDE.md → docs/development/testing.md
- Archived 12 PHASE_*.md files to docs/archive/
- Updated CHANGELOG.md with v0.2.0 details
- Created main README.md with badges and links to docs
Benefits:
- Clear documentation hierarchy by user journey
- Easier navigation with centralized docs/README.md index
- Reduced clutter in repository root
- Improved cross-referencing between documents
- Better onboarding for new users and contributors
Phase 1 deliverables (1-2 days estimated, completed):
✅ Organized docs/ directory structure
✅ Consolidated installation guides
✅ Streamlined development documentation
✅ Updated CHANGELOG to v0.2.0
✅ Archived phase completion files
✅ Created documentation hub
✅ Updated main README with navigation
✅ Fixed cross-references
Next: Phase 2 - API documentation with TypeDoc
Generated with [Claude Code](https://claude.ai/code)
via [Happy](https://happy.engineering)
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Happy <yesreply@happy.engineering>
Gandalf the Greybeard
Chris Farhood