canonical / canonical/discoursifier

Should top-level headers be removed?

Open
#9 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
1
Forks
1
PR merge metrics
No merged PRs in 30d

Description

I'm looking at the Snapcraft documentation in [Discourse](https://forum.snapcraft.io/t/documentation-guidelines/3798) and I see that they do not use level 1 headers ("We don’t use the top-level heading (# Heading) because the topic title in Discourse serves this purpose."). This makes sense when viewing within Discourse (i.e. you see both the title and level 1 close together) and it [looks like](https://docs.snapcraft.io/documentation-guidelines/3798) the Discourse title gets used as a top level header when published on the web.

Should top-level headers in the original (Juju documentation) files be removed during import?

Contributor guide

No contributing guide indexed for this repository

Research direction

Read the linked Snapcraft Documentation Guidelines and compare the Discourse source with the published documentation example. Then locate the import path that handles top-level headings, determine the intended behavior, and confirm completion by documenting or testing the chosen heading treatment.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, tooling
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.