exercism / exercism/docs

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

Open
#382 0 comments 2 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
52
Forks
98
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.