diff --git a/docs/context-intro.md b/docs/context/overview.md similarity index 99% rename from docs/context-intro.md rename to docs/context/overview.md index b746f2aa6..d3861a91a 100644 --- a/docs/context-intro.md +++ b/docs/context/overview.md @@ -1,5 +1,5 @@ --- -id: context-intro +id: overview sidebar_label: Context Data Overview title: Context Data Overview hide_title: true diff --git a/docs/context/ref/Contact.md b/docs/context/ref/Contact.md new file mode 100644 index 000000000..bff758317 --- /dev/null +++ b/docs/context/ref/Contact.md @@ -0,0 +1,48 @@ +--- +id: Contact +sidebar_label: Contact +title: Contact +hide_title: true +--- +# `Contact` + +A person contact that can be engaged with through email, calling, messaging, CMS, etc. + +## Type + +`fdc3.contact` + +## Schema + +https://fdc3.finos.org/schemas/next/contact.schema.json + +## Details + +| Property | Type | Required | Value | +|------------|---------|----------|-------------------| +| `type` | string | Yes | `'fdc3.contact'` | +| `name` | string | No | `'Jane Doe'` | +| `id.email` | string | Yes | `'jane@mail.com'` | + +## Example + +```js +const contact = { + type: 'fdc3.contact', + id: { + email: 'nick@gmail.com' + }, + name: 'Nick Kolba' +} + +fdc3.broadcast(contact) +``` + +## See Also + +Context +- [ContactList](ContactList) + +Intents +- [StartChat](../../intents/ref/StartChat) +- [StartCall](../../intents/ref/StartCall) \ No newline at end of file diff --git a/docs/context/ref/ContactList.md b/docs/context/ref/ContactList.md new file mode 100644 index 000000000..8102072ab --- /dev/null +++ b/docs/context/ref/ContactList.md @@ -0,0 +1,9 @@ +--- +id: ContactList +sidebar_label: ContactList +title: ContactList +hide_title: true +--- +# `ContactList` + +_TO BE COMPLETED_ \ No newline at end of file diff --git a/docs/context/ref/Context.md b/docs/context/ref/Context.md new file mode 100644 index 000000000..470f65d8a --- /dev/null +++ b/docs/context/ref/Context.md @@ -0,0 +1,9 @@ +--- +id: Context +sidebar_label: Context +title: Context +hide_title: true +--- +# `Context` + +_TO BE COMPLETED_ \ No newline at end of file diff --git a/docs/context/ref/Country.md b/docs/context/ref/Country.md new file mode 100644 index 000000000..2190de946 --- /dev/null +++ b/docs/context/ref/Country.md @@ -0,0 +1,9 @@ +--- +id: Country +sidebar_label: Country +title: Country +hide_title: true +--- +# `Country` + +_TO BE COMPLETED_ \ No newline at end of file diff --git a/docs/context/ref/Instrument.md b/docs/context/ref/Instrument.md new file mode 100644 index 000000000..e11acca46 --- /dev/null +++ b/docs/context/ref/Instrument.md @@ -0,0 +1,7 @@ +--- +id: Instrument +sidebar_label: Instrument +title: Instrument +hide_title: true +--- +# `Instrument` \ No newline at end of file diff --git a/docs/context/ref/InstrumentList.md b/docs/context/ref/InstrumentList.md new file mode 100644 index 000000000..e40a50345 --- /dev/null +++ b/docs/context/ref/InstrumentList.md @@ -0,0 +1,9 @@ +--- +id: InstrumentList +sidebar_label: InstrumentList +title: InstrumentList +hide_title: true +--- +# `InstrumentList` + +_TO BE COMPLETED_ \ No newline at end of file diff --git a/docs/context/ref/Organization.md b/docs/context/ref/Organization.md new file mode 100644 index 000000000..411e800bf --- /dev/null +++ b/docs/context/ref/Organization.md @@ -0,0 +1,9 @@ +--- +id: Organization +sidebar_label: Organization +title: Organization +hide_title: true +--- +# `Organization` + +_TO BE COMPLETED_ \ No newline at end of file diff --git a/docs/context/ref/Portfolio.md b/docs/context/ref/Portfolio.md new file mode 100644 index 000000000..0ffe11e80 --- /dev/null +++ b/docs/context/ref/Portfolio.md @@ -0,0 +1,9 @@ +--- +id: Portfolio +sidebar_label: Portfolio +title: Portfolio +hide_title: true +--- +# `Portfolio` + +_TO BE COMPLETED_ \ No newline at end of file diff --git a/docs/context/ref/Position.md b/docs/context/ref/Position.md new file mode 100644 index 000000000..e62892a22 --- /dev/null +++ b/docs/context/ref/Position.md @@ -0,0 +1,9 @@ +--- +id: Position +sidebar_label: Position +title: Position +hide_title: true +--- +# `Position` + +_TO BE COMPLETED_ \ No newline at end of file diff --git a/docs/context-spec.md b/docs/context/spec.md similarity index 98% rename from docs/context-spec.md rename to docs/context/spec.md index e8d2766d6..31f146777 100644 --- a/docs/context-spec.md +++ b/docs/context/spec.md @@ -1,5 +1,5 @@ --- -id: context-spec +id: spec sidebar_label: Context Data Specification title: Context Data Specification hide_title: true @@ -84,7 +84,7 @@ The following are standard FDC3 context types. __Note:__ The specification for these types are shared with the [FINOS Financial Objects](https://fo.finos.org) definitions, JSON schemas are hosted with FDC3. - __fdc3.contact__ - - A person contact that can be engaged with through email, calling, messaging, CMS, etc. As opposed to a person entity that relates to news, financial data, etc. + - A person contact that can be engaged with through email, calling, messaging, CMS, etc. - [Financial Objects Specification](https://fo.finos.org/docs/objects/contact) - [schema](https://github.com/finos/FDC3/blob/master/src/context/schemas/contact.schema) - __fd3.contactList__ diff --git a/docs/intents-intro.md b/docs/intents/overview.md similarity index 99% rename from docs/intents-intro.md rename to docs/intents/overview.md index 3330f2510..8a2e2670f 100644 --- a/docs/intents-intro.md +++ b/docs/intents/overview.md @@ -1,5 +1,5 @@ --- -id: intents-intro +id: overview sidebar_label: Intents Overview title: Intents Overview hide_title: true diff --git a/docs/intents/ref/StartCall.md b/docs/intents/ref/StartCall.md new file mode 100644 index 000000000..3f73c42cd --- /dev/null +++ b/docs/intents/ref/StartCall.md @@ -0,0 +1,9 @@ +--- +id: StartCall +sidebar_label: StartCall +title: StartCall +hide_title: true +--- +# `StartCall` + +_TO BE COMPLETED_ \ No newline at end of file diff --git a/docs/intents/ref/StartChat.md b/docs/intents/ref/StartChat.md new file mode 100644 index 000000000..37f25dc49 --- /dev/null +++ b/docs/intents/ref/StartChat.md @@ -0,0 +1,45 @@ +--- +id: StartChat +sidebar_label: StartChat +title: StartChat +hide_title: true +--- +# `StartChat` + +Initiate a chat with a contact or list of contacts. + +## Intent Name + +`StartChat` + +## Display Name + +`Chat` + +## Possible Contexts + +* [Contact](../../context/ref/Contact) +* [ContactList](../../context/ref/ContactList) + +## Example + +```js +const contact = { + type: 'fdc3.contact', + id: { + email: 'nick@gmail.com' + }, + name: 'Nick Kolba' +} + +fdc3.raiseIntent('StartChat', contact) +``` + +## See Also + +Context +- [Contact](../../context/ref/Contact) +- [ContactList](../../context/ref/ContactList) + +Intents +- [StartCall](StartCall) \ No newline at end of file diff --git a/docs/intents/ref/ViewAnalysis.md b/docs/intents/ref/ViewAnalysis.md new file mode 100644 index 000000000..55e7deaa9 --- /dev/null +++ b/docs/intents/ref/ViewAnalysis.md @@ -0,0 +1,9 @@ +--- +id: ViewAnalysis +sidebar_label: ViewAnalysis +title: ViewAnalysis +hide_title: true +--- +# `ViewAnalysis` + +_TO BE COMPLETED_ \ No newline at end of file diff --git a/docs/intents/ref/ViewChart.md b/docs/intents/ref/ViewChart.md new file mode 100644 index 000000000..4c1ecc330 --- /dev/null +++ b/docs/intents/ref/ViewChart.md @@ -0,0 +1,9 @@ +--- +id: ViewChart +sidebar_label: ViewChart +title: ViewChart +hide_title: true +--- +# `ViewChart` + +_TO BE COMPLETED_ \ No newline at end of file diff --git a/docs/intents/ref/ViewContact.md b/docs/intents/ref/ViewContact.md new file mode 100644 index 000000000..7a589c105 --- /dev/null +++ b/docs/intents/ref/ViewContact.md @@ -0,0 +1,9 @@ +--- +id: ViewContact +sidebar_label: ViewContact +title: ViewContact +hide_title: true +--- +# `ViewContact` + +_TO BE COMPLETED_ \ No newline at end of file diff --git a/docs/intents/ref/ViewInstrument.md b/docs/intents/ref/ViewInstrument.md new file mode 100644 index 000000000..9575b0b45 --- /dev/null +++ b/docs/intents/ref/ViewInstrument.md @@ -0,0 +1,9 @@ +--- +id: ViewInstrument +sidebar_label: ViewInstrument +title: ViewInstrument +hide_title: true +--- +# `ViewInstrument` + +_TO BE COMPLETED_ \ No newline at end of file diff --git a/docs/intents/ref/ViewNews.md b/docs/intents/ref/ViewNews.md new file mode 100644 index 000000000..e57783801 --- /dev/null +++ b/docs/intents/ref/ViewNews.md @@ -0,0 +1,9 @@ +--- +id: ViewNews +sidebar_label: ViewNews +title: ViewNews +hide_title: true +--- +# `ViewNews` + +_TO BE COMPLETED_ \ No newline at end of file diff --git a/docs/intents/ref/ViewQuote.md b/docs/intents/ref/ViewQuote.md new file mode 100644 index 000000000..814c85ba1 --- /dev/null +++ b/docs/intents/ref/ViewQuote.md @@ -0,0 +1,9 @@ +--- +id: ViewQuote +sidebar_label: ViewQuote +title: ViewQuote +hide_title: true +--- +# `ViewQuote` + +_TO BE COMPLETED_ \ No newline at end of file diff --git a/docs/intents-spec.md b/docs/intents/spec.md similarity index 99% rename from docs/intents-spec.md rename to docs/intents/spec.md index 6c176a7f6..c0d0937c2 100644 --- a/docs/intents-spec.md +++ b/docs/intents/spec.md @@ -1,5 +1,5 @@ --- -id: intents-spec +id: spec sidebar_label: Intents Specification title: Intents Specification hide_title: true diff --git a/website/sidebars.json b/website/sidebars.json index 762f4a555..30f5ad03e 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -24,12 +24,41 @@ } ], "Intents": [ - "intents-intro", - "intents-spec" + "intents/overview", + "intents/spec", + { + "type": "subcategory", + "label": "Reference", + "ids": [ + "intents/ref/StartCall", + "intents/ref/StartChat", + "intents/ref/ViewChart", + "intents/ref/ViewContact", + "intents/ref/ViewQuote", + "intents/ref/ViewNews", + "intents/ref/ViewAnalysis", + "intents/ref/ViewInstrument" + ] + } ], "Context Data": [ - "context-intro", - "context-spec" + "context/overview", + "context/spec", + { + "type": "subcategory", + "label": "Reference", + "ids": [ + "context/ref/Context", + "context/ref/Contact", + "context/ref/ContactList", + "context/ref/Instrument", + "context/ref/InstrumentList", + "context/ref/Organization", + "context/ref/Country", + "context/ref/Position", + "context/ref/Portfolio" + ] + } ], "App Directory": [ "appd-intro",