-
-
Notifications
You must be signed in to change notification settings - Fork 161
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
Regenerate instructions, sync and fix all README.md #244
Regenerate instructions, sync and fix all README.md #244
Conversation
The `TrackInsert` template variable allows the contents of the track specific documenation to be written in a markdown file (which allows tooling to highlight, lint and generally process this). Additionally, the `xit` to `it` hint was missing and added.
This updates all README.md to the canonical data as well as: - fix several issues with `npm` mentions - fix several issues with wording / outdated naming - custom edits where necessary
Generated by 🚫 Danger |
Could you do a check that new instruction do not conflict with tests implementations? The whole point of having separate readme is that we can guard against changes that would require rewriting the tests to be consistent? |
I did skim all the changes, but I'll make you a list with the exact changes. I'm about 95% certain that I caught all non-matching test issues already, so I'll go over it once more so we can be 100% certain 😄
Actually some of the tests should be updated to the canonical data; I've not seen a single diverge so far that is something else than outdated. But that's a different PR 🎉 |
A second lookSo there are a few exercises with notable changes. They are listed here after a thorough inspection:
ConclusionIMO this can be merged as is. I don't recommend removing the wording for EDIT: PRs are open. If they're merged, everything is in line with the changes in this PR. cc @masters3d |
Fixes #209
Extract track insert into separate file
The
TrackInsert
template variable allows the contents of the track specificdocumenation to be written in a markdown file (which allows tooling to highlight,
lint and generally process this).
Additionally, the
xit
toit
hint was missing and added.Regenerate all README.md
This updates all README.md to the canonical data as well as:
npm
mentions