bazelbuild / bazelbuild/stardoc
Generated markdown pages don't have a title
- Dominant language
- Java
- Stars
- 118
- Forks
- 51
- PR merge metrics
- No merged PRs in 30d
Description
It looks like the markdown pages never get a page title (`# TITLE` line), so the documented symbol gets a heading marking (`## SYMBOL_NAME`), and thus becomes the page title. So when the page has a few symbols things are a little odd when rendered by most markdown engines.
I'm not sure if #25 would be the way to fix this or if the intent is for everyone to use a custom template for every generated page.
Contributor guide
Research direction
No source file or test is identified in the issue. Start by tracing how Stardoc assembles generated Markdown pages, compare the output with the documented symbol heading, and confirm that rendered pages have an explicit page title before symbol headings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100