convert pdf to md, add OVERVIEW and docs
This commit is contained in:
@@ -0,0 +1,44 @@
|
||||
---
|
||||
type: object
|
||||
cluster: {identity | org | gradebook | money | trading | content}
|
||||
universe: live
|
||||
status: stub
|
||||
entity: {path to the owning file}
|
||||
---
|
||||
|
||||
# {Name}
|
||||
|
||||
{One sentence. If the product word and the class name differ, say both.}
|
||||
|
||||
## Why this shape
|
||||
|
||||
{The load-bearing why, not a field tour. What would break if it were the obvious shape
|
||||
instead?}
|
||||
|
||||
## Shape
|
||||
|
||||
- {keys, constraints, or owning files}
|
||||
|
||||
Citations: `{path}:{line}`
|
||||
|
||||
## Connected to
|
||||
|
||||
- **owns:**
|
||||
- **owned-by:**
|
||||
- **joins:**
|
||||
- **looks-like-but-is-not:**
|
||||
|
||||
## If you change this
|
||||
|
||||
- **Hits:**
|
||||
- **Does not hit:**
|
||||
|
||||
## Surfaces
|
||||
|
||||
| Surface | Role |
|
||||
|---|---|
|
||||
| {who} | {reads / writes / none} |
|
||||
|
||||
## See
|
||||
|
||||
- Source: `{path}`
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
type: process
|
||||
universe: live
|
||||
status: stub
|
||||
consumes: []
|
||||
produces: []
|
||||
---
|
||||
|
||||
# {process-name}
|
||||
|
||||
{One sentence: the movement, not the nouns.}
|
||||
|
||||
## Input → Movement → Output
|
||||
|
||||
{Three sentences.}
|
||||
|
||||
## Why this shape
|
||||
|
||||
{What would break if the obvious shortcut existed.}
|
||||
|
||||
## Steps
|
||||
|
||||
1. {Cite `{path}:{line}`.}
|
||||
|
||||
## If you change this
|
||||
|
||||
- **Hits:**
|
||||
- **Does not hit:**
|
||||
|
||||
## Surfaces
|
||||
|
||||
| Surface | Role |
|
||||
|---|---|
|
||||
| {who} | {role} |
|
||||
|
||||
## See
|
||||
|
||||
- Objects: {links}
|
||||
- Source: `{path}`
|
||||
Reference in New Issue
Block a user