epicweb-dev / epicweb-dev/epic-stack-docs

Initial Implementation

Open
#1 6 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
15
Forks
2
PR merge metrics
No merged PRs in 30d

Description

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](https://github.com/kentcdodds/kentcdodds.com) which is similar to the Epic Stack in many ways. [This file](https://github.com/kentcdodds/kentcdodds.com/blob/main/app/utils/compile-mdx.server.ts) is probably most helpful for compiling mdx on the fly. A simpler and similar implementation that you may reference is [the speed-metal-stack](https://github.com/Girish21/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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.