diff --git a/docs/src/architecture/Framework.md b/docs/src/architecture/Framework.md index a1ff283e16..229bee39c4 100644 --- a/docs/src/architecture/Framework.md +++ b/docs/src/architecture/Framework.md @@ -1,15 +1,3 @@ - - -**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* - -- [Overview](#overview) - - [Application Initialization](#application-initialization) - - [Architectural Paradigm](#architectural-paradigm) - - [Extension Categories](#extension-categories) - - [Composite Services](#composite-services) - - - # Overview The framework layer's most basic responsibility is allowing individual diff --git a/docs/src/architecture/Platform.md b/docs/src/architecture/Platform.md index cd788c3cd8..a59a6ebf9c 100644 --- a/docs/src/architecture/Platform.md +++ b/docs/src/architecture/Platform.md @@ -1,28 +1,3 @@ - - -**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* - -- [Overview](#overview) - - [Platform Architecture](#platform-architecture) - - [Application Start-up](#application-start-up) -- [Presentation Layer](#presentation-layer) - - [Angular built-ins](#angular-built-ins) - - [Domain object representation](#domain-object-representation) -- [Information Model](#information-model) - - [Capabilities and Services](#capabilities-and-services) -- [Service Infrastructure](#service-infrastructure) - - [Object Service](#object-service) - - [Model Service](#model-service) - - [Capability Service](#capability-service) - - [Telemetry Service](#telemetry-service) - - [Persistence Service](#persistence-service) - - [Action Service](#action-service) - - [View Service](#view-service) - - [Policy Service](#policy-service) - - [Type Service](#type-service) - - - # Overview The Open MCT Web platform utilizes the [framework layer](Framework.md) diff --git a/docs/src/architecture/index.md b/docs/src/architecture/index.md index cbf73592db..fd9e0961e1 100644 --- a/docs/src/architecture/index.md +++ b/docs/src/architecture/index.md @@ -1,13 +1,3 @@ - - -**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* - -- [Introduction](#introduction) -- [Overview](#overview) - - [Software Architecture](#software-architecture) - - - # Introduction The purpose of this document is to familiarize developers with the diff --git a/docs/src/guide/index.md b/docs/src/guide/index.md index 2261511280..7b35dd66cc 100644 --- a/docs/src/guide/index.md +++ b/docs/src/guide/index.md @@ -13,144 +13,6 @@ May 12, 2015 | 0.1 | | Victor Woeltjen June 4, 2015 | 1.0 | Name Changes | Victor Woeltjen October 4, 2015 | 1.1 | Conversion to MarkDown | Andrew Henry -# Contents - - - - - -- [Introduction](#introduction) - - [What is Open MCT Web](#what-is-open-mct-web) - - [Client-Server Relationship](#client-server-relationship) - - [Developing with Open MCT Web](#developing-with-open-mct-web) - - [Technologies](#technologies) - - [Forking](#forking) -- [Overview](#overview) - - [Framework Overview](#framework-overview) - - [Tiers](#tiers) - - [Platform Overview](#platform-overview) - - [Web Services](#web-services) - - [Glossary](#glossary) -- [Framework](#framework) - - [Bundles](#bundles) - - [Configuring Active Bundles](#configuring-active-bundles) - - [Bundle Definition](#bundle-definition) - - [Bundle Directory Structure](#bundle-directory-structure) - - [Extensions](#extensions) - - [General Extensions](#general-extensions) - - [Extension Definitions](#extension-definitions) - - [Partial Construction](#partial-construction) - - [Priority](#priority) - - [Angular Built-ins](#angular-built-ins) - - [Angular Directives](#angular-directives) - - [Angular Controllers](#angular-controllers) - - [Angular Services](#angular-services) - - [Angular Constants](#angular-constants) - - [Angular Runs](#angular-runs) - - [Angular Routes](#angular-routes) - - [Composite Services](#composite-services) -- [Core API](#core-api) - - [Domain Objects](#domain-objects) - - [Domain Object Actions](#domain-object-actions) - - [Action Contexts](#action-contexts) - - [Telemetry](#telemetry) - - [Telemetry Requests](#telemetry-requests) - - [Telemetry Responses](#telemetry-responses) - - [Telemetry Series](#telemetry-series) - - [Telemetry Metadata](#telemetry-metadata) - - [Types](#types) - - [Type Features](#type-features) - - [Type Properties](#type-properties) -- [Extension Categories](#extension-categories) - - [Actions Category](#actions-category) - - [Capabilities Category](#capabilities-category) - - [Controls Category](#controls-category) - - [Gestures Category](#gestures-category) - - [Indicators Category](#indicators-category) - - [Standard Indicators](#standard-indicators) - - [Custom Indicators](#custom-indicators) - - [Licenses Category](#licenses-category) - - [Policies Category](#policies-category) - - [Representations Category](#representations-category) - - [Representation Scope](#representation-scope) - - [Representers Category](#representers-category) - - [Roots Category](#roots-category) - - [Stylesheets Category](#stylesheets-category) - - [Templates Category](#templates-category) - - [Types Category](#types-category) - - [Versions Category](#versions-category) - - [Views Category](#views-category) - - [View Scope](#view-scope) - - [Selection State](#selection-state) -- [Directives](#directives) - - [Before Unload](#before-unload) - - [Chart](#chart) - - [Container](#container) - - [Control](#control) - - [Drag](#drag) - - [Form](#form) - - [Form Structure](#form-structure) - - [Form Controls](#form-controls) - - [Include](#include) - - [Representation](#representation) - - [Resize](#resize) - - [Scroll](#scroll) - - [Toolbar](#toolbar) - - [Toolbar Structure](#toolbar-structure) -- [Services](#services) - - [Composite Type Services](#composite-type-services) - - [Action Service](#action-service) - - [Capability Service](#capability-service) - - [Dialog Service](#dialog-service) - - [Dialog Structure](#dialog-structure) - - [Domain Object Service](#domain-object-service) - - [Gesture Service](#gesture-service) - - [Model Service](#model-service) - - [Persistence Service](#persistence-service) - - [Policy Service](#policy-service) - - [Telemetry Service](#telemetry-service) - - [Type Service](#type-service) - - [View Service](#view-service) - - [Other Services](#other-services) - - [Drag and Drop](#drag-and-drop) - - [Navigation](#navigation) - - [Now](#now) - - [Telemetry Formatter](#telemetry-formatter) - - [Telemetry Handler](#telemetry-handler) - - [Telemetry Handle](#telemetry-handle) -- [Models](#models) - - [General Metadata](#general-metadata) - - [Extension-specific Properties](#extension-specific-properties) - - [Capability-specific Properties](#capability-specific-properties) - - [View Configurations](#view-configurations) - - [Modifying Models](#modifying-models) -- [Capabilities](#capabilities) - - [Action Capability](#action-capability) - - [Composition Capability](#composition-capability) - - [Delegation Capability](#delegation-capability) - - [Editor Capability](#editor-capability) - - [Mutation Capability](#mutation-capability) - - [Mutator Function](#mutator-function) - - [Persistence Capability](#persistence-capability) - - [Relationship Capability](#relationship-capability) - - [Telemetry Capability](#telemetry-capability) - - [Type Capability](#type-capability) - - [View Capability](#view-capability) -- [Actions](#actions) - - [Action Categories](#action-categories) - - [Platform Actions](#platform-actions) -- [Policies](#policies) - - [Policy Categories](#policy-categories) -- [Build-Test-Deploy](#build-test-deploy) - - [Command-line Build](#command-line-build) - - [Test Suite](#test-suite) - - [Code Coverage](#code-coverage) - - [Deployment](#deployment) - - [Configuration](#configuration) - - [Configuration Constants](#configuration-constants) - - - # Introduction The purpose of this guide is to familiarize software developers with the Open MCT Web platform. diff --git a/docs/src/tutorials/index.md b/docs/src/tutorials/index.md index 720c80c828..d07466abac 100644 --- a/docs/src/tutorials/index.md +++ b/docs/src/tutorials/index.md @@ -14,46 +14,6 @@ July 28, 2015 | 2.0 | Telemetry adapter tutorial | Victor Woeltjen July 31, 2015 | 2.1 | Clarify telemetry adapter details | Victor Woeltjen October 14, 2015 | 2.2 | Conversion to markdown | Andrew Henry -# Contents - - - - - -- [Introduction](#introduction) - - [This document](#this-document) - - [Setting Up Open MCT Web](#setting-up-open-mct-web) - - [Prerequisites](#prerequisites) - - [Check out Open MCT Web Sources](#check-out-open-mct-web-sources) - - [Configuring Persistence](#configuring-persistence) - - [Bundle Before](#bundle-before) - - [Bundle After](#bundle-after) - - [Run a Web Server](#run-a-web-server) - - [Viewing in Browser](#viewing-in-browser) -- [Tutorials](#tutorials) - - [To-do List](#to-do-list) - - [Step 1-Create the Plugin](#step-1-create-the-plugin) - - [Before](#before) - - [After](#after) - - [Step 2-Add a Domain Object Type](#step-2-add-a-domain-object-type) - - [Step 3-Add a View](#step-3-add-a-view) - - [Step 4-Add a Controller](#step-4-add-a-controller) - - [Step 5-Support Editing](#step-5-support-editing) - - [Step 6-Customizing Look and Feel](#step-6-customizing-look-and-feel) - - [Bar Graph](#bar-graph) - - [Step 1-Define the View](#step-1-define-the-view) - - [Step 2-Add a Controller](#step-2-add-a-controller) - - [Step 3-Using Telemetry Data](#step-3-using-telemetry-data) - - [Step 4-View Configuration](#step-4-view-configuration) - - [Telemetry Adapter](#telemetry-adapter) - - [Step 0-Expose Your Telemetry](#step-0-expose-your-telemetry) - - [Step 1-Add a Top-level Object](#step-1-add-a-top-level-object) - - [Step 2-Expose the Telemetry Dictionary](#step-2-expose-the-telemetry-dictionary) - - [Step 3-Historical Telemetry](#step-3-historical-telemetry) - - [Step 4-Real-time Telemetry](#step-4-real-time-telemetry) - - - # Introduction ## This document