About These Docs

Welcome to the JodApp documentation. This is the single source of truth for all technical, operational, and business documentation.

Who Is This For?

• Engineers: Technical implementation guides, API references, and onboarding
• Operations: Support workflows, incident response, and runbooks
• Business: Partner documentation, sales materials, and policies

How This Is Organized

We use the Johnny Decimal system to organize documentation. This makes it easy to find information and helps AI assistants locate relevant context quickly.

Area Ranges

Range	Area	Description
00-09	Meta	Documentation system and conventions
10-19	Infrastructure	AWS, DevOps, networking, databases
20-29	Backend	Rails API technical guides
30-49	Domains	Business domain logic (DDD) - expanded range for bounded contexts
50-59	Frontend	Web and mobile applications
60-69	Operations	Support, incidents, runbooks
70-79	Business	Partners, sales, policies
80-89	Legacy	JodGig and JodPro archive
90-99	Engineering Meta	Onboarding, product strategy, and dev tools

How to Find Things

1. Identify the area: What type of information do you need?

   • Technical backend question? → 20-29 Backend
   • How does billing work? → 30-39 Domains
   • How to deploy? → 20-29 Backend → Deployment

2. Navigate to the category: Each area has numbered categories (e.g., 21-api-walkthrough, 22-deployment)

3. Find the specific page: Categories contain descriptive page folders

Example Navigation

To find information about the billing domain:

30-39-domains/           ← Area: Business Domains
  └── 32-billing/        ← Category: Billing
      ├── overview/      ← Page: Overview
      ├── models/        ← Page: Models
      └── credit-system/ ← Page: Credit System

For AI/LLM Integration

This documentation structure is optimized for AI assistants:

• Predictable locations: AI can infer where information lives based on the numbering
• Clear boundaries: Each area has a distinct purpose
• Glanceable structure: _category_.yml files show the full structure of each section
• Shallow depth: Maximum 4 levels (area/category/topic/index.md)

When using this documentation with NotebookLM or other AI tools, the descriptive folder names and Johnny Decimal areas make it easy to scope searches.