The OLYSENSE Developer Portal is intended to be the central hub for building, learning, and contributing to the way develop on the OLYSENSE platform. Whether you’re a seasoned developer, a curious contributor, or just getting started — this is the place for you. Our goal is to make development transparent, collaborative, and open to all.

The site is broken down into the following sections:

• Tutorials - Guided lessons that take you through a series of steps to complete a project. Most useful when you want to get started developing on OLYSENSE.
• How-To Guides - Practical step-by-step guides to help you achieve a specific goal. Most useful when you’re trying to get something done.
• User Flows - Use flows provide a visual and descriptive representation of the paths users take to complete tasks within the product.
• Resources - Contains relevant links to other resources outside of the developer portal that will help you in your journey of developing on the OLYSENSE platform.

In addition to this, we have also released the OLYSENSE React Demo site (referenced throughout the developer portal). This site is a react demo application that showcases various layouts and user flows leveraging the OLYSENSE Design System. This will be useful for engineers and designers to reference existing layouts and flows in a clean development environment, and will also enable us to prove out future solutions.

Why should I care about it?

One of the primary goals of the developer portal is to break down silos. One of the ways we can start to head in this direction is to document and align on the various ways we design and build on the OLYSENSE platform.

This site is intended to be the connective tissue that binds our teams together. We want and encourage contribution from all teams, with the end goal of bringing alignment among our squads in terms of how we build things.

Who should care about it?

Developers - This site is primarily for developers at this time. It’s intended to showcase how we build out solutions so we can bring alignment among our squads and foster more collaboration.

Designers - While the more technical sections may not be relevant to designers, the User Flows section will be a good reference point to see designs proved out in a live environment before a squad fully commits to a particular solution in their application.

Others - While a lot of this documentation is geared at developers, it can still be helpful for other roles to learn about how we build things and what we’re trying to solve for. So with that said, we encourage everyone to take a look and offer feedback. Knowledge is power!

Can I contribute?

YES! We want and encourage contribution from all teams, with the end goal of bringing alignment among our squads in terms of how we build things. The more we can reduce tribal knowledge, the better off we will be.

Don’t see something you think should be in here? Open a PR and document it or shoot us a message, we’d love to talk!

Is the Developer Portal done?

No! This is meant to evolve as our needs and solutions change.