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

Add Markdown Explanation Docs #23

Open
MondayMorningHaskell opened this issue Mar 9, 2021 · 0 comments
Open

Add Markdown Explanation Docs #23

MondayMorningHaskell opened this issue Mar 9, 2021 · 0 comments
Labels
good first issue Good for newcomers

Comments

@MondayMorningHaskell
Copy link
Owner

A good alternative to having all the explanations in comments in the exercise files would be to make a Markdown file for each exercise (or possibly each category of exercises, i.e. one for each sub-directory). These files would contain the exact text from the explanation blocks except formatted to Markdown. There should also be a link in the exercise file to the Markdown and vice-versa. There should also be a link in each Markdown document to the next explanation document.

Don't feel the need to do all the exercises at once. Entirely OK to do a few at a time.

@MondayMorningHaskell MondayMorningHaskell added the good first issue Good for newcomers label Mar 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant