DocPage.
One page of the documentation site: where it comes from, its claims, its examples and its Markdown twin
Figure 1DocPagespecified
- kind
- definition
- scope
- platform
- key
- its address
- store
- postgres
- family
- documentation
Fields#
| field | type | required | note |
|---|---|---|---|
address | text | yes | |
title | text | yes | |
description | text | yes | |
section | DocSection | yes | |
source | one of hand-written | from the contract | from a register | yes | |
generated_from | text | no | the document or the register a generated page is built from |
claims | DocClaim | yes | |
examples | DocExample | yes | |
twin | text | yes | the address with .md appended |
structured_data | json | yes | JSON-LD |
updated | time | yes | |
contract_hash | hash | yes |
Routes that use it#
No route takes or returns DocPage directly. The record holds it, and the objects that point at it reach it.