Initial Implementation
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 20/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- markdown, typescript
- Domain
- documentation
Research direction
Review the linked app/utils/compile-mdx.server.ts example and compare it with the referenced speed-metal-stack implementation. Define how this repository will host the docs and site, compile Markdown/MDX at runtime with caching, and support updates without redeployment. Done means the agreed architecture is implemented and documented.
Written by the indexing model from the issue text.
Description
Just a few thoughts:
- I would like the docs to use markdown and be hosted publicly on GitHub
- I would like the site and source for the docs to be in this repo
- 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.
- Dominant language
- TypeScript
- Stars
- 15
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
safetrustcr/dApp-SafeTrust#426 ·
-
area:workflow bug ready-for-agent
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
fil-donadoni/tolaria#4409 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Fission-AI/OpenSpec#1960 ·
-
Add dependabot Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
corsairdev/corsair#1764 ·