Skip to main content

Getting Started!

Welcome to the Rainfall-Learning internal documentation. This guide will help you navigate and make the most of our documentation resources.

Documentation Structure​

Our documentation is organized into several key sections:

Architecture​

Technical architecture documentation covering system design, infrastructure, and core components. Start here if you're new to the codebase or need to understand how different services interact.

API Reference​

Complete API documentation including endpoints, request/response formats, authentication, and examples. Each endpoint includes curl examples and common use cases.

Shared Types​

The website automatically updates and reflects all types in the shared folder, meaning finding interfaces and exported types are super easy.

Development Guides​

Step-by-step guides for common development tasks:

  • Setting up your local environment
  • Running tests
  • Debugging common issues
  • Deployment procedures

Best Practices​

Team conventions and coding standards:

  • Code style guidelines
  • Git workflow
  • PR review process
  • Security considerations

Documentation Standards​

When contributing, please follow these guidelines:

# Page Title (H1 - only one per page)

Brief introduction paragraph explaining what this page covers.

## Main Section (H2)

Content here...

### Subsection (H3)

More detailed content...

Code Examples: Always include working examples

// Good: Complete, runnable example
const client = new RainfallLearningClient({
  apiKey: process.env.RAINFALL_API_KEY,
  environment: 'production',
});

const result = await client.users.list({ limit: 10 });

Important Notes: Use callouts for critical information

note

Always sanitize user input before processing

warning

This endpoint is rate-limited to 100 requests per minute

Getting Help​

Internal Resources​

  • Discord: #general or your team channel or DMing tech leads for quick help

Documentation Issues​

  • Missing documentation? Create a ticket!
  • Incorrect information? Report it immediately!
  • Need clarification? Ask in #general first

Frequently Used Pages​

Quick links to our most visited documentation:

Remember: Good documentation is a team effort. If something helped you, it might help others too. Don't hesitate to contribute!