-
-
Notifications
You must be signed in to change notification settings - Fork 95
update concept about.md explanation #80
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
update concept about.md explanation #80
Conversation
Looking great. Here are at least two answer:
These three things will work:
|
There's info on this in the linking doc: https://github.com/exercism/docs/blob/main/anatomy/tracks/internal-linking.md
The about.md becomes the content on a Concept page (e.g. https://exercism.lol/tracks/javascript/concepts/basics) once that Concept has been learnt. Before the concept has been learnt, the introduction.md shows instead. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks really good. Thank you. I've made a few small suggestions and capitalized Concept and Exercise throughout as they're considered proper nouns within Exercism.
I'd also like to get @ErikSchierboom to sign it off before it gets merged.
Co-authored-by: Jeremy Walker <jez.walker@gmail.com>
@iHiD Thanks for the fixes and additions! I accepted the suggestions and also added the link to the "internal linking" document you provided. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Excellent work! I've left some small nits.
Co-authored-by: Erik Schierboom <erik_schierboom@hotmail.com>
@ErikSchierboom Thanks for the feedback. 😊 Changes are included now. |
LGTM Thanks! 🎉 |
exercism/javascript#1021 triggered a discussion about the intended content of the about.md file.
This PR is indented to improve the documentation for a concepts' about.md file. The old version contained some artifacts from the old "after.md of an exercise" approach what resulted in misunderstandings.
The new explanation is based mainly on the input @iHiD gave in Slack.
I replaced the example to use something that included a common pitfall to better illustrate the difference to the introduction.md file.
Additional info I would like to include if someone can provide them: