Skip to content
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

Building - Practice Exercise Docs: Clarify how append file is rendered #382

Open
junedev opened this issue Sep 21, 2022 · 0 comments
Open

Comments

@junedev
Copy link
Member

junedev commented Sep 21, 2022

This is regarding this section:
https://exercism.org/docs/building/tracks/practice-exercises#h-file-docs-instructions-append-md

We had a lot of issues because people were not aware that the h1 header is removed and that the append content is rendered directly below the original instructions without any kind of separation. Usually you want to use an h2 after the h1 because of that so the content structure makes sense in end. Would be good to clarify how it works. Ideally with screenshots that illustrates it.

@junedev junedev changed the title Bulding - Practice Exercise Docs: Clarify how append file is rendered Building - Practice Exercise Docs: Clarify how append file is rendered Nov 14, 2022
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

No branches or pull requests

1 participant