Table of Contents
Welcome to FinFocus documentation. Use this page to navigate all available resources.
Quick Navigation by Audience
Section titled “Quick Navigation by Audience”👤 For End Users
Section titled “👤 For End Users”- Start: 5-Minute Quickstart
- Install: Installation Guide
- Learn: User Guide
- Configure: Budgets | Recommendations
- Command Reference: CLI Commands
- Get Help: FAQ | Troubleshooting
🛠️ For Engineers/Plugin Developers
Section titled “🛠️ For Engineers/Plugin Developers”- Start: Developer Guide
- Build: Plugin Development
- Reference: Plugin SDK
- Example: AWS Public Plugin
- Contribute: Contributing Guide
🏗️ For Software Architects
Section titled “🏗️ For Software Architects”- Overview: Architecture Guide
- Design: System Architecture
- Patterns: Plugin Protocol
- Deploy: Deployment Guide
- Secure: Security Guide
💼 For Executives/Product
Section titled “💼 For Executives/Product”- Value: Business Value & ROI
- See Demo: Quickstart
- Timeline: Roadmap
- Details: System Architecture
Full Documentation Index
Section titled “Full Documentation Index”📘 Getting Started
Section titled “📘 Getting Started”| Page | Purpose | Audience |
|---|---|---|
| 5-Minute Quickstart | Get running in 5 minutes | Everyone |
| Installation Guide | Step-by-step installation | End Users, Ops |
| Prerequisites | System requirements | Everyone |
| Examples | Practical usage examples | End Users |
| AWS Public Setup | AWS public pricing plugin | End Users |
📚 Comprehensive Guides (by Audience)
Section titled “📚 Comprehensive Guides (by Audience)”| Page | Purpose | Length |
|---|---|---|
| User Guide | Complete end user guide | Long |
| Developer Guide | Complete engineer guide | Long |
| Architecture Guide | Complete architect guide | Long |
| Business Value | Executive summary & ROI | Medium |
🚀 Feature Guides
Section titled “🚀 Feature Guides”| Page | Purpose |
|---|---|
| Budget Configuration | Configure budgets, alerts, and thresholds |
| Resource History | Track resource identity for accurate costs |
| Recommendations | Use cost optimization recommendations |
| Accessibility | Configure colors, contrast, and TUI |
🏗️ Architecture & Design
Section titled “🏗️ Architecture & Design”| Page | Purpose |
|---|---|
| System Overview | High-level architecture with diagrams |
| Core Concepts | Key concepts (resources, costs, aggregation) |
| Plugin Protocol | gRPC plugin specification |
| Cost Calculation | How costs are calculated |
| Actual vs Projected | Understanding cost types |
| Roadmap | Planned features and timeline |
📊 Architecture Diagrams
Section titled “📊 Architecture Diagrams”| Diagram | Shows |
|---|---|
| System Architecture | Component overview |
| Data Flow | How data flows through system |
| Plugin Lifecycle | Plugin discovery & startup |
| Cost Calculation Flow | Cost calculation pipeline |
| Integration Example | End-to-end: Pulumi → FinFocus → Vantage |
🔌 Plugin Documentation
Section titled “🔌 Plugin Documentation”Development
Section titled “Development”| Page | Purpose |
|---|---|
| Plugin Development Guide | How to build a plugin |
| Plugin SDK Reference | API and SDK documentation |
| Plugin Examples | Code examples and patterns |
| Plugin Checklist | Ensure plugin is complete |
AWS Public (AVAILABLE)
Section titled “AWS Public (AVAILABLE)”| Page | Purpose |
|---|---|
| AWS Public Plugin | Setup and configuration |
Kubecost (PLANNED)
Section titled “Kubecost (PLANNED)”| Page | Purpose |
|---|---|
| Coming Soon | Timeline and features |
Future Plugins
Section titled “Future Plugins”| Page | Status |
|---|---|
| Flexera Coming Soon | FUTURE (customer demand) |
| Cloudability Coming Soon | FUTURE (customer demand) |
📖 Reference Documentation
Section titled “📖 Reference Documentation”| Page | Purpose |
|---|---|
| CLI Commands | Complete command reference |
| Configuration | Configuration file reference |
| API Reference | gRPC API documentation |
| Error Codes | Error codes and solutions |
| Environment Variables | Env var reference |
🚀 Deployment & Operations
Section titled “🚀 Deployment & Operations”| Page | Purpose |
|---|---|
| Installation Guide | Detailed installation |
| Configuration Guide | Configuration how-to |
| Deployment Architecture | Deployment diagram |
| Docker | Docker deployment |
| Kubernetes | K8s deployment (future) |
| CI/CD Integration | Pipeline integration |
| Security | Security best practices |
| Troubleshooting | Operational issues |
💬 Support & Community
Section titled “💬 Support & Community”| Page | Purpose |
|---|---|
| FAQ | Frequently asked questions |
| Troubleshooting | Problem-solving by symptom |
| Contributing | How to contribute |
| Code of Conduct | Community guidelines |
| Support Channels | Where to get help |
📋 Setup & Configuration
Section titled “📋 Setup & Configuration”| Page | Purpose |
|---|---|
| GitHub Pages Setup | Enable docs deployment |
| Developer Setup | Local development environment |
📚 Meta Documentation
Section titled “📚 Meta Documentation”| Page | Purpose |
|---|---|
| Documentation Plan | Documentation architecture strategy |
| LLM Index | Machine-readable documentation index |
Documentation by Topic
Section titled “Documentation by Topic”Getting Started (New Users)
Section titled “Getting Started (New Users)”- README - Start here
- Quickstart - 5 minutes
- Installation - Install
- User Guide - Learn
Installation & Setup
Section titled “Installation & Setup”Using FinFocus
Section titled “Using FinFocus”- Quickstart
- User Guide
- Budgets & Alerts
- Resource History & Cost Tags
- Cost Recommendations
- Accessibility Options
- CLI Commands
- Examples
Building Plugins
Section titled “Building Plugins”System Design
Section titled “System Design”Operations & Deployment
Section titled “Operations & Deployment”Troubleshooting & Support
Section titled “Troubleshooting & Support”Contributing
Section titled “Contributing”Business/Strategy
Section titled “Business/Strategy”Search Tips
Section titled “Search Tips”Use Ctrl+F to search within pages:
- “How do I…” - See User Guide
- “Setup” - See Installation Guide
- “Plugin” - See Plugin Documentation
- “Error” - See Troubleshooting
- “Architecture” - See Architecture Guide
- “Cost” - See Cost Calculation
Documentation Status
Section titled “Documentation Status”| Section | Status | Coverage |
|---|---|---|
| Getting Started | ✅ Complete | 100% |
| Guides | ✅ Complete | 100% |
| Architecture | 🟡 Partial | 60% |
| Plugins | 🟡 Partial | 50% |
| Reference | 🟡 Partial | 60% |
| Deployment | 🟡 Partial | 50% |
| Support | ✅ Complete | 80% |
Quick Links
Section titled “Quick Links”Last Updated: 2025-10-29
Next Steps: Choose your starting point above based on your role!