Build applications with Door43 Bible translation resources
Comprehensive guides for APIs, formats, and implementation patterns
1. Read: Why unfoldingWord Resources → Understand the ecosystem
2. Implement: Door43 API Guide → Get data from repositories
3. Handle: Bible Text Format Guide → Display USFM content
4. Add: Translation Notes Guide → Show verse-level helps
Time: ~4 hours | Difficulty: ⭐⭐ Intermediate
1. Study: unfoldingWord Developer Guide → Learn resource architecture
2. Implement: Door43 API Guide → CRUD operations for content
3. Handle: All Repository Formats → Support multiple resource types
4. Add: Migration Guides → Convert between formats
Time: ~2-3 days | Difficulty: ⭐⭐⭐ Advanced
This repository contains comprehensive developer documentation for the Door43 ecosystem:
- Why unfoldingWord Translation Resources - Mission and ecosystem overview
- Getting Started Guide - Foundation concepts for Bible translation technology
- unfoldingWord Developer Guide - Complete resource architecture
- Door43 API Developer Guide - Practical API implementation patterns
- Resource Container - Standard unfoldingWord formats (Bible texts, translation helps)
- Scripture Burrito - Alternative Bible resource format
- Tool-Generated - translationCore and translationStudio formats
- Resource Container → Scripture Burrito conversion guides
- Format-specific migration instructions
| Resource Type | What It Contains | Format Guide |
|---|---|---|
| Bible Texts | USFM Scripture (UHB, UGNT, ULT, UST) | Bible Text Guide |
| Translation Notes | Verse-level translation guidance | Translation Notes Guide |
| Translation Words | Biblical term definitions | Translation Words Guide |
| Translation Questions | Quality assurance questions | Translation Questions Guide |
| Translation Academy | Translation methodology training | Translation Academy Guide |
| Open Bible Stories | 50 key Bible stories | Open Bible Stories Guide |
Basic Resource Access:
1. Authenticate with Door43 API
2. Discover repositories by language/organization
3. Detect resource specification (RC/SB/Tool)
4. Process content according to format guide
Multi-Resource Applications:
1. Load Bible text as primary content
2. Overlay translation notes for verse guidance
3. Link translation words for term definitions
4. Add translation questions for quality checks
- Door43 Content Service - Live repository browser
- Door43 API Swagger - Complete API reference
- Resource Container Spec - Official RC specification
Building AI tools or automated systems? Check out our comprehensive AI developer guide:
📋 AI Developer Guide - Complete roadmap for AI systems, MCP implementations, and automated tools
This repository powers a beautiful documentation site built with docs.page:
- 🔍 Full-text search across all guides
- 📱 Mobile-responsive design
- 🌙 Dark/light theme support
- 🔗 Cross-referenced content
- ⚡ Fast loading with optimized delivery
We welcome contributions to improve the documentation!
- Fork this repository
- Create a feature branch (
git checkout -b improve-docs) - Make your changes following our style guidelines
- Test your changes locally with docs.page preview
- Submit a pull request
- Use natural language instructions (implementation-agnostic)
- Include real examples from actual Door43 repositories
- Follow the frontmatter schema for metadata
- Add cross-references to related guides
- Test all internal links
- ✅ Step-by-step instructions that work with any programming language
- ✅ Clear explanations with real-world examples
- ✅ Proper frontmatter with categories and tags
- ❌ Programming language-specific code examples
- ❌ Pseudocode or algorithms
docs/
├── index.mdx # Main documentation index
├── 0-getting-started.mdx # Introduction and learning paths
├── 1-why-unfoldingword-translation-resources.mdx # Mission and ecosystem
├── 2-unfoldingword-developer-guide.mdx # Complete technical specification
├── 3-door43-api-developer-guide.mdx # Practical API implementation
├── 4-repository-formats/ # Format-specific documentation
│ ├── resource-container/ # RC specification guides
│ ├── scripture-burrito/ # SB specification guides
│ └── tool-generated/ # Tool-specific formats
├── 5-migration/ # Format conversion guides
├── automation/ # MCP and automation tools
└── assets/ # Icons, schemas, and resources
AI_DEVELOPER_GUIDE.md # AI systems implementation guide
- 📄 29 guides covering all major Door43 repository types
- 🔧 3 specifications (Resource Container, Scripture Burrito, Tool-Generated)
- 🔄 6 migration guides for format conversion
- 🤖 4 automation tools for MCP systems
- 📋 Comprehensive cross-references between all guides
- 📖 Browse the docs: docs.page/unfoldingWord/uW-Tools-Collab
- 🐛 Report issues: GitHub Issues
- 💬 Ask questions: GitHub Discussions
- 🔗 Official API docs: git.door43.org/api/swagger
This documentation is licensed under the MIT License.
This documentation supports the unfoldingWord mission to provide unrestricted biblical content in every language. The Door43 platform hosts comprehensive Bible translation resources that help Mother Tongue Translators create Scripture translations in their heart languages.
These resources are designed for the Open Components Ecosystem community, enabling developers to build interoperable Bible translation applications with shared, reusable components.
Ready to build?
- Human developers: Start with the Door43 API Developer Guide for practical implementation patterns
- AI systems: Begin with the AI Developer Guide for comprehensive automation guidance