Draft illustrating how we might document feeds & schemas

[Christian-MK]

@ross-spencer can we nest pages this deeply in docusaurus?
I envisioned something like

├─Introduction
├─Orcfax solution
├─Fact token
├─FAQ
├─Feeds
│   ├─ Overview // somewhere for high level definitions
|   ├─CER
|   |   ├─ CEX
│   |   |   ├─ fact-statment.json // schema.org definitions for each type and property
│   |   |   ├─ fact-statment-datum.json
│   |   |   ├─ message.json
│   |   |   └─ validation.json
│   |   └─ DEX
│   |   |   ├─ fact-statment.json // schema.org definitions for each type and property
│   |   |   ├─ fact-statment-datum.json
│   |   |   ├─ message.json
│   |   |   └─ validation.json
|   └─ Other // allows us to continue adding other feed types
├─ITN
├─Node operation
└─Developer manual

[ross-spencer]

Never thought we could use JSON in the docs like this but it looks like a really good start, +1 here.

You've tagged Gabriel, so let's see if he can use this approach, otherwise happy to brainstorm on other ideas if not.

[Christian-MK]

Never thought we could use JSON in the docs like this

To be clear. I dont know that this can/should be done. I was only reacting to what @gchartier mentioned in our meeting the other day.

You didn't answer my question though about whether we can have a directory in docusaurus with nested pages as I have illustrated in my example. I feel like it must be possible, but couldn't fins the answer to my question in the documentation

[ross-spencer]

Oh, I didn't realize there was a further question. Still not quite sure, but it looks like you tried it and it built?

I also tried something here following your approach - if we install the raw-loader extension then we can render the schema in the pages as well as deliver them as JSON. The layout would look similar to yours still but json files would be added to the static dir, e.g. static/schema/cer/cex/... and so on.

#24

What do you think?

NB. the nesting looks okay too?