Skip to content
This repository has been archived by the owner on Aug 31, 2021. It is now read-only.

[Kotlin] Add concept introductions #2988

Merged
merged 2 commits into from
Jan 13, 2021
Merged

Conversation

ErikSchierboom
Copy link
Member

We've recently specified that each concept should have its own introduction.md file: https://github.com/exercism/v3-docs/blob/master/anatomy/tracks/concepts.md#file-introductionmd.

This PR tries to automatically add these introduction.md files for each of the concept of your track. It does that as follows:

  • If there is an exercise that teaches that concept:
    • If the exercise has a level 2 heading that matches the concept slug: create the introduction.md file with the contents directly following the level 2 header
    • Else: create the introduction.md file with its contents being the exercise's entire introduction.md file, but with a TODO added to the top
  • Else: create the introduction.md file containing a TODO placeholder

See #2975

@ErikSchierboom ErikSchierboom requested a review from a team as a code owner January 8, 2021 09:38
@ErikSchierboom
Copy link
Member Author

/format

@dector
Copy link
Member

dector commented Jan 8, 2021

Should it be different from introduction in exercises?

@ErikSchierboom
Copy link
Member Author

ErikSchierboom commented Jan 8, 2021

They can be, but in most cases they probably won't be. I've written up more information here: #2983 (comment)

@ErikSchierboom
Copy link
Member Author

/format

@ErikSchierboom
Copy link
Member Author

/format

@github-actions github-actions bot added the type/documentation Improvements or additions to documentation label Jan 8, 2021
@ErikSchierboom ErikSchierboom merged commit 6c9f896 into master Jan 13, 2021
@ErikSchierboom ErikSchierboom deleted the kotlin-concept-introductions branch January 13, 2021 12:46
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
track/kotlin type/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants