OriginProtocol/origin-docs-archived

🎓Replace Slate as our documentation system?

Opened this issue · 1 comments

I think Slate won't scale as our documentation system. Slate is designed to generate a giant single page document, and maxes out at two levels of headings for navigation.

Our Origin docs need to document more than one origin system, which doesn't fit into Slate's navigation model, and having everything in one page is already unwieldy at the current size of our documentation.

We need to control the page hierarchy/navigation, and that's fundamentally not what Slate is about.

Here's what I'd like to see:

  • Multi page documentation
  • We control menu/navigation
  • Markdown based. We all speak it.
  • Prefer including arbitrary markdown files, vs one fixed directory that docs live in. With a monorepo this would let us keep docs with their own projects, and yet build a single documentation site from it.
  • Support for code highlighting
  • Nice to be Javascript or python based. (but speed and fewer dependencies are far more important)

Thoughts?


Documentation systems:

More generic systems:

Others?

image