Template
Use this when creating a new _index.md file for the landing page of a new section of the API Reference for a new data entity.
You can copy-and-paste this template:
---
title: Title
---
## Concepts
[Content]
### Relationships
[Content]
### Details
[Content]
## Learning Materials
### Quickstarts
[Content]
### Guides
[Content]
Breakdown
Breakdown of each part of the template:
title
This is the title of the landing page.
In general (but not always), this matches the name of the data entity (e.g. if this is for Transactions or Accounts then that’s the value for the title).
Concepts
This helps the reader answer the question: what is this thing?
Oftentimes the answer is relatively straightforward as many of the data entities that we have in the API are commonly-used terms in the fintech industry. However, that isn’t always the case so it’s good to make sure that we provide a definition here.
Relationships
This helps the reader understand how this data entity relates to other data entities. For example, Transactions are related to Accounts.
Details
This is used to add more information that isn’t captured in the Swagger spec or is difficult to explain within the Swagger spec. At a minimum, this has a link to the details spec.
Note: this part of the template can have siblings. For example, the Accounts API Reference has Details, Orders, and Rewards as siblings that correspond to each of those separate Swagger spec files for Accounts.
Learning Materials
This is used to link readers to any additional docs that we have available (where applicable). We currently have two types: Quickstarts and Guides.
Quickstarts
This is used to link readers to any Quickstarts that exist to get readers quickly up to speed with how to use the data entity (where applicable).
Guides
This is used to link readers to any Guides that exist to illustrate how to use the data entity in specific ways or to accomplish specific tasks (where applicable).