lf-lang / lf-lang/lf-lang.github.io
Move actual docs to lf-lang main repo
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 7
- Forks
- 21
- Avg merge
- 9h 46m
- Merged PRs (30d)
- 2
Description
This was something we thought about a while ago.
MDX Docs will be version-controlled along with lf-lang repo to ensure they are up-to-date. This website checks out docs from the repo with different tags and builds website from time to time with these docs, without containing any actual document.
Should we still proceed along this route?
Contributor guide
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.
Research direction
Review how the website currently checks out MDX docs from the lf-lang repository by tag and builds the site, then compare that with keeping the docs version-controlled in the main repo. Done means deciding whether to proceed and documenting the resulting repository and build arrangement.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100