{"id":25622629,"url":"https://github.com/unfoldingword/uw-tools-collab","last_synced_at":"2026-02-12T21:02:07.735Z","repository":{"id":185455505,"uuid":"669245677","full_name":"unfoldingWord/uW-Tools-Collab","owner":"unfoldingWord","description":"This is a repo for tracking team level work","archived":false,"fork":false,"pushed_at":"2025-09-12T15:52:46.000Z","size":656,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-09-15T09:55:59.536Z","etag":null,"topics":["scripture-open-components"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/unfoldingWord.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-07-21T17:51:46.000Z","updated_at":"2025-09-12T15:52:50.000Z","dependencies_parsed_at":null,"dependency_job_id":"6e9e8507-be8f-4466-8fcf-f7ba796277b4","html_url":"https://github.com/unfoldingWord/uW-Tools-Collab","commit_stats":null,"previous_names":["unfoldingword/uw-tools-collab"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/unfoldingWord/uW-Tools-Collab","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldingWord%2FuW-Tools-Collab","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldingWord%2FuW-Tools-Collab/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldingWord%2FuW-Tools-Collab/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldingWord%2FuW-Tools-Collab/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unfoldingWord","download_url":"https://codeload.github.com/unfoldingWord/uW-Tools-Collab/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unfoldingWord%2FuW-Tools-Collab/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29381030,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-12T20:34:40.886Z","status":"ssl_error","status_checked_at":"2026-02-12T20:23:00.490Z","response_time":55,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["scripture-open-components"],"created_at":"2025-02-22T10:20:01.557Z","updated_at":"2026-02-12T21:02:07.720Z","avatar_url":"https://github.com/unfoldingWord.png","language":null,"readme":"# Door43 Developer Documentation\n\n\u003e **Build applications with Door43 Bible translation resources**  \n\u003e Comprehensive guides for APIs, formats, and implementation patterns\n\n[![Documentation](https://img.shields.io/badge/docs-docs.page-blue)](https://docs.page/unfoldingWord/uW-Tools-Collab)\n[![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)\n[![GitHub Issues](https://img.shields.io/github/issues/unfoldingWord/uW-Tools-Collab)](https://github.com/unfoldingWord/uW-Tools-Collab/issues)\n\n## 🚀 **Quick Start**\n\n### **Building a Bible Reading App?**\n```\n1. Read: Why unfoldingWord Resources → Understand the ecosystem\n2. Implement: Door43 API Guide → Get data from repositories  \n3. Handle: Bible Text Format Guide → Display USFM content\n4. Add: Translation Notes Guide → Show verse-level helps\n```\n**Time: ~4 hours** | **Difficulty: ⭐⭐ Intermediate**\n\n### **Creating a Translation Editor?**\n```\n1. Study: unfoldingWord Developer Guide → Learn resource architecture\n2. Implement: Door43 API Guide → CRUD operations for content\n3. Handle: All Repository Formats → Support multiple resource types\n4. Add: Migration Guides → Convert between formats\n```\n**Time: ~2-3 days** | **Difficulty: ⭐⭐⭐ Advanced**\n\n## 📚 **What's Inside**\n\nThis repository contains comprehensive developer documentation for the Door43 ecosystem:\n\n### **[Getting Started](docs/)**\n- **[Why unfoldingWord Translation Resources](docs/1-why-unfoldingword-translation-resources.mdx)** - Mission and ecosystem overview\n- **[Getting Started Guide](docs/0-getting-started.mdx)** - Foundation concepts for Bible translation technology\n\n### **[Developer Guides](docs/)**\n- **[unfoldingWord Developer Guide](docs/2-unfoldingword-developer-guide.mdx)** - Complete resource architecture\n- **[Door43 API Developer Guide](docs/3-door43-api-developer-guide.mdx)** - Practical API implementation patterns\n\n### **[Repository Formats](docs/4-repository-formats/)**\n- **[Resource Container](docs/4-repository-formats/resource-container/)** - Standard unfoldingWord formats (Bible texts, translation helps)\n- **[Scripture Burrito](docs/4-repository-formats/scripture-burrito/)** - Alternative Bible resource format  \n- **[Tool-Generated](docs/4-repository-formats/tool-generated/)** - translationCore and translationStudio formats\n\n### **[Migration \u0026 Conversion](docs/5-migration/)**\n- **[Resource Container → Scripture Burrito](docs/5-migration/rc-to-sb/)** conversion guides\n- **[Format-specific migration instructions](docs/5-migration/migration-guide-index.mdx)**\n\n### **[Automation \u0026 MCP](docs/automation/)**\n- **[MCP instructions for AI systems](docs/automation/mcp-implementation-example.mdx)**\n- **[Batch processing and repository analysis tools](docs/automation/door43-repository-analyzer-mcp.mdx)**\n\n## 🎯 **Find What You Need**\n\n| Resource Type | What It Contains | Format Guide |\n|---------------|------------------|--------------|\n| **Bible Texts** | USFM Scripture (UHB, UGNT, ULT, UST) | [Bible Text Guide](docs/repository-formats/resource-container/bible-text-repositories-guide.mdx) |\n| **Translation Notes** | Verse-level translation guidance | [Translation Notes Guide](docs/repository-formats/resource-container/translation-notes-repositories-guide.mdx) |\n| **Translation Words** | Biblical term definitions | [Translation Words Guide](docs/repository-formats/resource-container/translation-words-repositories-guide.mdx) |\n| **Translation Questions** | Quality assurance questions | [Translation Questions Guide](docs/repository-formats/resource-container/translation-questions-repositories-guide.mdx) |\n| **Translation Academy** | Translation methodology training | [Translation Academy Guide](docs/repository-formats/resource-container/translation-academy-repositories-guide.mdx) |\n| **Open Bible Stories** | 50 key Bible stories | [Open Bible Stories Guide](docs/repository-formats/resource-container/open-bible-stories-repositories-guide.mdx) |\n\n## 🛠️ **For Developers**\n\n### **Common Implementation Patterns**\n\n**Basic Resource Access:**\n```\n1. Authenticate with Door43 API\n2. Discover repositories by language/organization\n3. Detect resource specification (RC/SB/Tool)\n4. Process content according to format guide\n```\n\n**Multi-Resource Applications:**\n```\n1. Load Bible text as primary content\n2. Overlay translation notes for verse guidance\n3. Link translation words for term definitions\n4. Add translation questions for quality checks\n```\n\n### **API Resources**\n- **[Door43 Content Service](https://git.door43.org/)** - Live repository browser\n- **[Door43 API Swagger](https://git.door43.org/api/swagger)** - Complete API reference\n- **[Resource Container Spec](https://resource-container.readthedocs.io/)** - Official RC specification\n\n## 🤖 **For AI Developers \u0026 Automation**\n\nBuilding AI tools or automated systems? Check out our comprehensive AI developer guide:\n\n**📋 [AI Developer Guide](AI_DEVELOPER_GUIDE.md)** - Complete roadmap for AI systems, MCP implementations, and automated tools\n\n## 📖 **Documentation Site**\n\nThis repository powers a beautiful documentation site built with [docs.page](https://docs.page/):\n\n**🌐 [View Live Documentation](https://docs.page/unfoldingWord/uW-Tools-Collab)**\n\n### **Features:**\n- 🔍 **Full-text search** across all guides\n- 📱 **Mobile-responsive** design\n- 🌙 **Dark/light theme** support\n- 🔗 **Cross-referenced** content\n- ⚡ **Fast loading** with optimized delivery\n\n## 🤝 **Contributing**\n\nWe welcome contributions to improve the documentation!\n\n### **How to Contribute:**\n\n1. **Fork** this repository\n2. **Create** a feature branch (`git checkout -b improve-docs`)\n3. **Make** your changes following our [style guidelines](docs/assets/frontmatter-schema.md)\n4. **Test** your changes locally with docs.page preview\n5. **Submit** a pull request\n\n### **Documentation Standards:**\n- Use **natural language** instructions (implementation-agnostic)\n- Include **real examples** from actual Door43 repositories\n- Follow the **frontmatter schema** for metadata\n- Add **cross-references** to related guides\n- Test all **internal links**\n\n### **Content Guidelines:**\n- ✅ Step-by-step instructions that work with any programming language\n- ✅ Clear explanations with real-world examples\n- ✅ Proper frontmatter with categories and tags\n- ❌ Programming language-specific code examples\n- ❌ Pseudocode or algorithms\n\n## 🏗️ **Repository Structure**\n\n```\ndocs/\n├── index.mdx                           # Main documentation index\n├── 0-getting-started.mdx               # Introduction and learning paths\n├── 1-why-unfoldingword-translation-resources.mdx  # Mission and ecosystem\n├── 2-unfoldingword-developer-guide.mdx # Complete technical specification\n├── 3-door43-api-developer-guide.mdx    # Practical API implementation\n├── 4-repository-formats/               # Format-specific documentation\n│   ├── resource-container/             # RC specification guides\n│   ├── scripture-burrito/              # SB specification guides\n│   └── tool-generated/                 # Tool-specific formats\n├── 5-migration/                        # Format conversion guides\n├── automation/                         # MCP and automation tools\n└── assets/                             # Icons, schemas, and resources\nAI_DEVELOPER_GUIDE.md                   # AI systems implementation guide\n```\n\n## 📊 **Documentation Stats**\n\n- **📄 29 guides** covering all major Door43 repository types\n- **🔧 3 specifications** (Resource Container, Scripture Burrito, Tool-Generated)\n- **🔄 6 migration guides** for format conversion\n- **🤖 4 automation tools** for MCP systems\n- **📋 Comprehensive cross-references** between all guides\n\n## 🆘 **Getting Help**\n\n- **📖 Browse the docs**: [docs.page/unfoldingWord/uW-Tools-Collab](https://docs.page/unfoldingWord/uW-Tools-Collab)\n- **🐛 Report issues**: [GitHub Issues](https://github.com/unfoldingWord/uW-Tools-Collab/issues)\n- **💬 Ask questions**: [GitHub Discussions](https://github.com/unfoldingWord/uW-Tools-Collab/discussions)\n- **🔗 Official API docs**: [git.door43.org/api/swagger](https://git.door43.org/api/swagger)\n\n## 📄 **License**\n\nThis documentation is licensed under the [MIT License](LICENSE).\n\n## 🌍 **About unfoldingWord \u0026 Open Components**\n\nThis documentation supports the [unfoldingWord](https://unfoldingword.org/) 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.\n\nThese resources are designed for the [Open Components Ecosystem](https://opencomponents.io/) community, enabling developers to build interoperable Bible translation applications with shared, reusable components.\n\n---\n\n**Ready to build?**\n- **Human developers**: Start with the [Door43 API Developer Guide](docs/3-door43-api-developer-guide.mdx) for practical implementation patterns\n- **AI systems**: Begin with the [AI Developer Guide](AI_DEVELOPER_GUIDE.md) for comprehensive automation guidance\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funfoldingword%2Fuw-tools-collab","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funfoldingword%2Fuw-tools-collab","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funfoldingword%2Fuw-tools-collab/lists"}