Skip to content

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

Merged
merged 4 commits into from
Mar 3, 2021

Conversation

junedev
Copy link
Member

@junedev junedev commented Mar 2, 2021

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:

@SleeplessByte
Copy link
Member

Looking great. Here are at least two answer:

How to properly link to another concept? I have seen links like exercism.lol/tracks/ruby/concepts/conditionals but those would need to be replaced later.

These three things will work:

How exactly would a student reach the about.md page?

  1. Via the concept tree (e.g. https://exercism.lol/tracks/javascript/concepts), then clicking on a concept.
  2. Via a different concept page.
  3. Via any other document that supports markdown, because there can be direct links and widgets to these concept pages.
  4. Clicking the concept on https://exercism.lol/tracks/javascript/exercises/basics (after completion, but also before, I think).

@iHiD
Copy link
Member

iHiD commented Mar 2, 2021

How to properly link to another concept? I have seen links like https://exercism.lol/tracks/ruby/concepts/conditionals but those would need to be replaced later.

There's info on this in the linking doc: https://github.com/exercism/docs/blob/main/anatomy/tracks/internal-linking.md

How exactly would a student reach the about.md page?

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.

Copy link
Member

@iHiD iHiD left a 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.

junedev and others added 2 commits March 3, 2021 08:29
Co-authored-by: Jeremy Walker <jez.walker@gmail.com>
@junedev
Copy link
Member Author

junedev commented Mar 3, 2021

@iHiD Thanks for the fixes and additions! I accepted the suggestions and also added the link to the "internal linking" document you provided.

Copy link
Member

@ErikSchierboom ErikSchierboom left a 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>
@junedev
Copy link
Member Author

junedev commented Mar 3, 2021

@ErikSchierboom Thanks for the feedback. 😊 Changes are included now.

@ErikSchierboom ErikSchierboom merged commit 5b6732e into exercism:main Mar 3, 2021
@ErikSchierboom
Copy link
Member

LGTM Thanks! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants