all-docs.md

All Documentation Index

Complete listing of all Fern Platform documentation

📚 Documentation Categories

Getting Started

• Product Overview - What is Fern Platform and why use it
• Quick Start Guide - Get running in 15 minutes
• Workflows Guide - How to use Fern effectively

User Guides

• UI Features - Dashboard and visualization features
• Use Cases
  • Debugging Test Failures - Understanding why tests fail
  • Finding Flaky Tests - Identify unreliable tests
  • Test Performance Monitoring - Track test execution times
  • Authentication Flow - OAuth login process
  • Project Management - Managing projects
  • Test Summaries - Viewing test results
  • Test Run Details - Detailed test information
  • PM Connectors - JIRA/PM integrations

Developer Documentation

• Architecture Overview - System design and principles
• API Reference - REST API documentation
• GraphQL API - Query language for complex data retrieval
• Integration Guide - Connect your CI/CD pipeline
• Local Development - Development environment setup
• Networking & DNS - Network configuration
• Dagger CI/CD Guide - Using Dagger for CI/CD

Configuration

• OAuth Setup - Authentication configuration
• Permissions System - Role-based access control
• Permission Examples - Common permission scenarios
• Test Users - Pre-configured test accounts
• User Permissions - Managing user access

Operations

• Local K3D Setup - Kubernetes deployment
• Troubleshooting Guide - Common issues and solutions
• Security Policy - Security practices and reporting

Architecture & Design

• Domain-Driven Design - Business domain structure
• Technical Decisions - Architecture analysis
• Future Plans (RFCs)
  • RFC-001: Platform Consolidation
  • RFC-002: AI/LLM Integration
  • RFC-003: Requirements Traceability

Project Information

• README - Project overview and status
• Contributing Guide - How to contribute
• Code of Conduct - Community guidelines

🔍 Quick Links by Task

"I want to..."

Deploy Fern Platform

1. Quick Start → Local K3D Setup
2. OAuth Configuration → Test Users

Integrate with CI/CD

1. Integration Guide → API Reference
2. Dagger Guide for Dagger users

Analyze Test Results

1. Finding Flaky Tests
2. Performance Monitoring
3. Debugging Failures

Troubleshoot Issues

1. Troubleshooting Guide
2. Networking & DNS for connection issues

Contribute to Development

1. Contributing Guide
2. Architecture Overview
3. Local Development

📊 Documentation Status

✅ Complete and Current

• All user guides and use cases
• API documentation
• Configuration guides
• Troubleshooting guide

🚧 In Progress

• SDK documentation (planned)
• Advanced deployment scenarios
• Performance tuning guide

📅 Planned

• Video tutorials
• Best practices guide
• Migration guides from other platforms

🔗 External Resources

• GitHub Repository
• Issue Tracker
• Discussions
• Releases

---

Can't find what you're looking for? Open an issue to let us know!