cake-build / cake-build/website

Change to H2 for TOC

Open
#1,080 11 comments 1 reaction 0 assignees View on GitHub
enhancement help wanted up-for-grabs
Dominant language
HTML
Stars
52
Forks
256
Avg merge
4h 42m
Merged PRs (30d)
8

Description

We currently use H1 in our document pages to build the TOC on the right hand column. To follow semantic best practices we should only have one H1 on the page (the title) and use headings starting with H2 for structuring page content.

We would need to configure Wyam to pickup H2 for building the TOC:

```
Pipelines["RenderPages"].InsertAfter("WriteMetadata", new Headings(3); // Heading level
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Search the Wyam configuration for the RenderPages pipeline and the WriteMetadata insertion point shown in the issue. Confirm how the Headings level controls the right-column TOC, then verify that rendered document pages use H2 for content structure while retaining a single H1 title.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.