atomic-data-docs icon indicating copy to clipboard operation
atomic-data-docs copied to clipboard

Docs sourcing data from Atomic Server instead of git repo

Open joepio opened this issue 2 years ago • 0 comments

docs.atomicdata.dev is a static page built from this repo. That has a bunch of advantages:

  • Matches my workflow (code editor, markdown, git)
  • Static pages are fast
  • It looks like a book / docs. For rust devs it will look very familiar
  • Has some nice built-in features (Table of Contents, git edit page, search, go to next page button)

Still, it would be nice if we could let this docs repo be powered by Atomic Data, or more specifically, Atomic Server.

  • Makes content findable on atomicdata.dev's search capabilitities, making these components feel like one.
  • By dogfeeding, we make sure one new usecase is supported, in this case the static site
  • We want Atomic-Server to be a powerful CMS, so we should demonstrate that
  • Live updates! However, this can be a bit annoying if we don't have the draft feature yet.

joepio avatar Mar 04 '23 10:03 joepio