Welcome to the Fast Scriptures project documentation! This guide will help you navigate our documentation and find exactly what you need.
Start here if you're just getting started:
- Project Overview - What Fast Scriptures is and what it does
- Developer Guide - Complete setup, workflow, and first contribution
- Contributing Guidelines - How to contribute effectively
- Architecture Overview - How the system works
Essential guides for effective development:
- Developer Guide - Complete development setup and workflow
- Testing Guide - Comprehensive testing strategy and practices
- API Standards - API design principles and best practices
- Automation Guide - Using our automation tools and Makefiles
- Git Submodules - Working with the scripture data submodule
Deploying and maintaining the application:
- Deployment Guide - How to deploy to Render and other platforms
- Operations Guide - Monitoring, observability, and SRE practices
Detailed technical references:
- Release Notes - Version history and changelog details
- Screenshots - Application screenshots and visual documentation
🐛 Report a bug or issue
- Check our Contributing Guide for reporting guidelines
- Browse existing issues first
- Review Developer Guide troubleshooting for common problems
✨ Add a new feature or contribute code
- Start with Developer Guide for complete setup
- Read Contributing Guidelines for best practices
- Understand our API Standards and Testing Guide
🔧 Set up my development environment
- Follow the Developer Guide for step-by-step setup
- Use our Automation Guide for build tools
- Check Testing Guide for running tests
🚀 Deploy the application
- Follow the Deployment Guide for production deployment
- Set up Operations Guide for monitoring and observability
📖 Understand how everything works
- Start with Project Overview and Developer Guide
- Review API Standards for backend design principles
- Check Release Notes for feature evolution
| Document | Status | Last Updated | For |
|---|---|---|---|
| Developer Guide | ✅ Complete | Current | All Developers |
| Testing Guide | ✅ Complete | Current | Developers |
| Operations Guide | ✅ Complete | Current | DevOps/SRE |
| API Standards | ✅ Complete | Current | Backend Developers |
| Deployment Guide | ✅ Complete | Current | DevOps |
| Automation Guide | ✅ Complete | Current | Developers |
| Contributing Guidelines | ✅ Complete | Current | Contributors |
| Submodules Guide | ✅ Complete | Current | Developers |
| Architecture Overview | ✅ Complete | Current | All |
- Check the main project README for basic information
- Browse GitHub issues and discussions
- Look through our release notes for feature history
Found something confusing or missing? We welcome documentation improvements!
- Read our Contributing Guidelines
- Follow the Developer Guide for setup
- Submit a PR with your documentation improvements
Quick Links: Main README | Contributing | Developer Guide | Latest Release