ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-05-09 20:12:50 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
openmct/docs/src/index.md
Jesse Mazzella 4ee68cccd6
docs: better docs and types for the API (#7796) 
* docs: fix type imports in openmct.js

* docs: fix type imports

* docs: fix types for eventHelpers

* docs: types for TypeRegistry

* docs: types for StatusAPI

* docs: fix ObjectAPI types and docs

* docs: more types

* docs: improved types for main entry

* docs: improved types

* fix: unbreak the linting

* chore: remove EventEmitter webpack alias as it hide types

* fix: return type

* fix: parameter type

* fix: types for composables

* chore: add webpack consts to eslintrc

* fix: remove usage of deprecated timeAPI methods and add a ton of docs and types

* docs: update README.md

* lint: clean up API.md

* chore: upgrade eventemitter to v5.0.2

* refactor: update imports for EventEmitter to remove alias

* format: lint

* docs: update types for Views and ViewProviders

* docs: expose common types at the base import level

* docs(types): remove unnecessary tsconfig options

* docs: ActionAPI

* docs: AnnotationAPI

* docs: import common types from the same origin

* docs: FormsAPI & TelemetryAPI types

* docs: FormController, IndicatorAPI

* docs: MenuAPI, ActionsAPI

* docs: `@memberof` is not supported by `tsc` and JSDoc generation so remove it

* docs: RootRegistry and RootObjectProvider

* docs: Transaction + Overlay

* lint: words for the word god

* fix: review comments
2024-07-31 10:46:16 -07:00

1.1 KiB
Raw Permalink Blame History

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 uses inline documentation. using TypeScript and some legacy JSDoc. It describes the JavaScript objects and functions that make up the software platform.

  • The Development Process document describes the Open MCT software development cycle.

  • The tutorial and plugin template give examples of extending the platform to add functionality and integrate with data sources.