search

epicweb-dev / epic-stack-docs

The documentation for the Epic Stack
17 stars 2 forks source link

Initial Implementation #1

Open kentcdodds opened 10 months ago

kentcdodds commented 10 months ago

Just a few thoughts:

  1. I would like the docs to use markdown and be hosted publicly on GitHub
  2. I would like the site and source for the docs to be in this repo
  3. I would like an update to the docs to not require a redeploy of the site (so runtime markdown compilation via mdx-bundler maybe + caching will be necessary).

I'm really thinking the architecture can be similar to my site which is similar to the Epic Stack in many ways. This file is probably most helpful for compiling mdx on the fly. A simpler and similar implementation that you may reference is the speed-metal-stack which is based on my personal site.

Personally, I'd probably start with the Epic Stack and remove stuff we don't want. I think keeping the user accounts could actually be useful for the admin interface with the cache etc.

swalker326 commented 10 months ago

Just a point of clarity,

Can the docs be hosted in this repo as well or did you envision them in a completely separate repo all together? I think I understand the requirement that you don't want to have to redeploy to make changes, I think we can accomplish that via github actions and still host all the markdown in this repo.

kentcdodds commented 10 months ago

Thanks @swalker326! Sorry, when I wrote this initially, I was writing it in a comment on the other discussion then I moved it over here and didn't update that part 😅

I think all the docs should be in this repo, code and the docs files themselves 😅

swalker326 commented 10 months ago

Hey @kentcdodds I got a bunch of cool stuff pushed today and working. I was wondering if we can do a call (maybe this week) and I can run you through it and maybe get some input on if this is a good direction or not. Got search working and build time mdx working which were two I was kind of unsure of.

a3af99cb-4999-402b-820e-21995d9d7219

kentcdodds commented 10 months ago

This is awesome! Thank you! I'd love to do a call sometime. Shoot me an email and we can schedule something: me@kentcdodds.com

Thanks again! I'm loving this!

swalker326 commented 10 months ago

Email sent, I've had it reported a couple times that my email went to spam. If you don't see it check there 😬

kentcdodds commented 10 months ago

Yep. That went to spam 😅 Will reply there. Thanks!