application-services/docs

Firefox Application Services Docs

This directory is the documentation root for all the products managed by the Firefox Application Services Team.

The ./product-portal/ directory contains the source docs for the consumer-facing product portal website, which can be viewed here:

• https://mozilla.github.io/application-services/

Everything else in this directory is contributor-facing documentation to help you work on app-services projects. We have:

• A high-level guide to Contributing to Application Services
• The Synconomicon, a deep dive into the internals of sync and storage for Firefox Applications.
• The Sync and Storage Handbook, which provides a higher-level view of our sync and storage components.
• Docs for various infrastructure pieces:
  • Our Dependency Management Policies
  • Our Build and Publish Pipeline
• Architectural design docs:
  • How megazording works, and why we do it.
  • The motivation and design of the sync manager.
• Howtos for specific coding activities:
  • Code and architecture guidelines:
    • Guide to Building a Rust Component
    • How to expose your Rust Component to Kotlin
    • How to expose your Rust Component to Swift
    • How to pass data cross the FFI boundary
      • How to do that specifically using protobuf
  • Development Tooling:
    • How to set up your local android build environment
    • How to try out local changes in Fenix
    • How to try out local changes in the Reference Browser
    • How to access logs for debugging
  • Process guidelines:
    • How to cut a new release
• For consumers:
  • Guide to Consuming Rust Components on Android
  • Guide to Consuming Rust Components on iOS