mirror of
https://github.com/nasa/openmct.git
synced 2025-02-12 05:35:56 +00:00
38 lines
1.5 KiB
Markdown
38 lines
1.5 KiB
Markdown
# Open MCT Documentation
|
|
|
|
## Overview
|
|
|
|
Documentation is provided to support the use and development of
|
|
Open MCT. It's recommended that before doing
|
|
any development with Open MCT you take some time to familiarize yourself
|
|
with the documentation below.
|
|
|
|
Open MCT provides functionality out of the box, but it's also a platform for
|
|
building rich mission operations applications based on modern web technology.
|
|
The platform is configured by plugins which extend the platform at a variety
|
|
of extension points. The details of how to
|
|
extend the platform are provided in the following documentation.
|
|
|
|
## Sections
|
|
|
|
* The [API](api/) document is generated from inline documentation
|
|
using [JSDoc](http://usejsdoc.org/), and describes the JavaScript objects and
|
|
functions that make up the software platform.
|
|
|
|
* The [Development Process](process/) document describes the
|
|
Open MCT software development cycle.
|
|
|
|
## Legacy Documentation
|
|
|
|
As we transition to a new API, the following documentation for the old API
|
|
(which is supported during the transtion) may be useful as well:
|
|
|
|
* The [Architecture Overview](architecture/) describes the concepts used
|
|
throughout Open MCT, and gives a high level overview of the platform's design.
|
|
|
|
* The [Developer's Guide](guide/) goes into more detail about how to use the
|
|
platform and the functionality that it provides.
|
|
|
|
* The [Tutorials](https://github.com/nasa/openmct-tutorial) give examples of extending the platform to add
|
|
functionality, and integrate with data sources.
|