Skip to content

Format all instructions.append.md to start with an H1 (required but ignored) and H2#587

Merged
giacomocavalieri merged 2 commits into
exercism:mainfrom
IsaacG:append.headers
May 27, 2026
Merged

Format all instructions.append.md to start with an H1 (required but ignored) and H2#587
giacomocavalieri merged 2 commits into
exercism:mainfrom
IsaacG:append.headers

Conversation

@IsaacG

@IsaacG IsaacG commented May 25, 2026

Copy link
Copy Markdown
Member

See related discussions here as well as exercism/docs#592. Append files should all have an H1. Including an H2 helps break the flow from the non-append file to the append file so it does not read as the same stream of thought.

@lpil

lpil commented May 25, 2026

Copy link
Copy Markdown
Member

Hello! What's this?

@IsaacG

IsaacG commented May 25, 2026

Copy link
Copy Markdown
Member Author

The H1 line on append files is required but not displayed. An H2 is needed to separate the extra instructions from the end of the regular instructions. Without an H2, it all runs together.

I'm updating at the tracks to ensure append files start with H1 and H2.

@lpil

lpil commented May 25, 2026

Copy link
Copy Markdown
Member

Is there an issue or documentation for this? Thank you 🙏

@IsaacG

IsaacG commented May 25, 2026

Copy link
Copy Markdown
Member Author

Is there an issue or documentation for this? Thank you 🙏

No. Issues don't work cross repo. There's two related forum threads here and here.

As far as I'm aware, the append header behavior is an undocumented quirk that some maintainers are aware of but I can't find docs for that. We could work on that.

@IsaacG

IsaacG commented May 25, 2026

Copy link
Copy Markdown
Member Author

The practice exericse page shows the H1 placeholder header but doesn't show an H2 and doesn't spell things out.

@IsaacG

IsaacG commented May 25, 2026

Copy link
Copy Markdown
Member Author

exercism/docs#592 to document headers in append files

@IsaacG

IsaacG commented May 25, 2026

Copy link
Copy Markdown
Member Author

@lpil lpil left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Great, thank you for the information!

@giacomocavalieri giacomocavalieri merged commit 571772a into exercism:main May 27, 2026
2 checks passed
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