Skip to main content

Welcome to the Osborn Project Documentation

This is the central hub for all documentation, development standards, rules, and other resources related to the development of the Osborn project. Here you will find detailed information about our frontend, backend, and Figma plugin.

Overview​

Our goal is to provide a comprehensive and easy-to-navigate resource for our development team and collaborators. This documentation is a living document and will be updated continuously as the project evolves.

What you'll find here:​

  • Development Guides: Instructions and best practices for setting up your development environment and contributing to the project.
  • Architectural Documentation: In-depth explanations of the architecture for each part of our system.
  • Coding Standards: Rules and conventions to ensure code quality and consistency across the project.
  • API References: Detailed documentation for our APIs.

Project Components​

The project is divided into three main components:

  • Frontend: Everything related to our web application, from the user interface to client-side logic.
  • Backend: The core services, APIs, and databases that power our application. (Documentation in progress)
  • Figma Plugin: Documentation for our Figma plugin, including its architecture, how to use it, and how to contribute.