Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs sourcing data from Atomic Server instead of git repo #157

Open
joepio opened this issue Mar 4, 2023 · 0 comments
Open

Docs sourcing data from Atomic Server instead of git repo #157

joepio opened this issue Mar 4, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@joepio
Copy link
Member

joepio commented Mar 4, 2023

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 joepio added the documentation Improvements or additions to documentation label Dec 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant