From 6690a7f9522a79056cc62286e1a6b437e83a3739 Mon Sep 17 00:00:00 2001 From: edeustace Date: Fri, 23 Feb 2018 16:40:49 -0500 Subject: [PATCH 1/2] start updating the docs --- .../developing/{summary.md => introduction.md} | 14 ++++++++++++-- src/layouts/DocsPage/index.js | 2 +- 2 files changed, 13 insertions(+), 3 deletions(-) rename content/docs/developing/{summary.md => introduction.md} (81%) diff --git a/content/docs/developing/summary.md b/content/docs/developing/introduction.md similarity index 81% rename from content/docs/developing/summary.md rename to content/docs/developing/introduction.md index 97890191..29214d03 100644 --- a/content/docs/developing/summary.md +++ b/content/docs/developing/introduction.md @@ -1,8 +1,18 @@ -# Summary +# Introduction Each PIE is an individual UI Element or interaction that is designed to be re-used in the context of assessment. An example of a PIE might be a multi-choice question-type or a question-type that allows a student to make a bar chart or plot points on a graph. However a PIE does not to be a question type, it can be any Custom Element. -Users can configure one or more instances of PIEs to create questions/assessment experiences for students. See [Rendering Items](/using/rendering-items.md) +Users can configure one or more instances of PIEs to create questions/assessment experiences for students. See [Rendering Items](/using/rendering-items.md). + + +# The pieces of a PIE + +A PIE is at a minimum a package that defines a custom element for rendering. It may also define a controller for processing the model before sending it to the ui element and also a configuration ui to allow the data model to be altered. All these parts are defined by using some packaging conventions. Follow the links below for more detail: + +* [defining a pie package](/developing/packaging) +* [element](/developing/element) +* [controller](/developing/controller) +* [configuration](/developing/confiration) To create a PIE a developer implements: diff --git a/src/layouts/DocsPage/index.js b/src/layouts/DocsPage/index.js index f0bc456a..110fc00c 100644 --- a/src/layouts/DocsPage/index.js +++ b/src/layouts/DocsPage/index.js @@ -47,7 +47,7 @@ export default function DocsPage(props) {
  • PIE Development