Skip to content

Update introduction.md #2031

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
Oct 6, 2021
Merged

Update introduction.md #2031

merged 4 commits into from
Oct 6, 2021

Conversation

myucesan
Copy link
Contributor

@myucesan myucesan commented Oct 1, 2021

Added examples and added more explanation on the operators.

pull request


Reviewer Resources:

Track Policies

Added examples and added more explanation on the operators.
Copy link
Contributor

@mirkoperillo mirkoperillo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A suggestion to improve the contribution

Merged with previous line per suggestion
Copy link
Contributor

@jmrunkle jmrunkle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mind also updating the about.md file?

@myucesan
Copy link
Contributor Author

myucesan commented Oct 3, 2021

Mind also updating the about.md file?

What's the difference between the two? Where does the introduction show and where does the about show?

@jmrunkle
Copy link
Contributor

jmrunkle commented Oct 4, 2021

What's the difference between the two? Where does the introduction show and where does the about show?

Described here: https://exercism.org/docs/building/tracks/concepts

about.md: provide information about the concept for a student who has completed the corresponding concept exercise to learn from and refer back to (required)
introduction.md: provide a brief introduction to a student who has not yet completed the corresponding concept exercise (required)

More comprehensively:

After completing the corresponding Concept Exercise (otherwise known as "learning" a Concept), the Concept page will show the contents of the about.md file instead of the introduction.md file. The about.md file should provide students with comprehensive information on what they need to know to be fluent in the concept. At a minimum, this file should contain all information that is introduced in the Concepts' introduction.md document.

@jmrunkle
Copy link
Contributor

jmrunkle commented Oct 4, 2021

They determine what is displayed here: https://exercism.org/tracks/java/concepts/booleans

Added => mirroring the comments in the about.md
@myucesan
Copy link
Contributor Author

myucesan commented Oct 5, 2021

Done with about.md, also added => arrows here like the about.md for consistency.

Co-authored-by: Jason Runkle <jmrunkle@gmail.com>
@jmrunkle jmrunkle dismissed mirkoperillo’s stale review October 6, 2021 17:47

Comment was addressed

@jmrunkle jmrunkle merged commit 9ce86e5 into exercism:main Oct 6, 2021
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.

3 participants