Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 1.1 KB

README.md

File metadata and controls

29 lines (20 loc) · 1.1 KB

Firefox Ecosystem Platform Docs

This repo hosts the source code and tooling for the Firefox Ecosystem Platform documentation portal.

Scope and Target Audience

The docs in this repository are intended for engineers, designers or product managers working on applications in the Firefox Ecosystem.

Our aim is to help them understand how and why to incorporate Account-related features into their application, in a way that makes the Firefox family of products feel like a cohesive cross-app and cross-device experience for users.

Working on the Docs

Our documentation is organized following a Divio strategy. If you modify these docs please use that structure.

The site is build using Docusaurus and is automatically deployed from master to GitHub Pages using CircleCI. To build and run it locally you can:

$> yarn install
$> yarn start

That should open a new browser window automatically, or you can manually browse to http://localhost:3333/ecosystem-platform/ to view the docs.