swift-book icon indicating copy to clipboard operation
swift-book copied to clipboard

Remove title heading and automatic see-also section

Open amartini51 opened this issue 1 year ago • 5 comments

Fixes #6

amartini51 avatar Oct 10 '22 21:10 amartini51

I'll test this with a recent DocC toolchain soon. In the meantime, it looks like this turns off the Article title headings; did we want to test out @TitleHeading("Chapter") as well? (Perhaps in a subsequent issue.)

krilnon avatar Oct 10 '22 21:10 krilnon

Changing the title heading to "Chapter" seems reasonable to me — if we like that better, I'm fine doing it all on this PR.

amartini51 avatar Oct 11 '22 00:10 amartini51

@SamLanier what are your design thoughts on using "Chapter" for the title headings instead of the default "Article"?

bjlanier avatar Oct 11 '22 04:10 bjlanier

I think both options could work. I'm not sure a title heading (eyebrow) makes the most sense to label the chapters (we currently use eyebrows to convey the content type, and the reason for hiding those eyebrows would be that the content type is assumed to be the same). That said, there's nothing wrong with using the eyebrow as a chapter heading temporarily until another solution would be better. For example, being able to see a TOC of all the chapters might be more useful to the reader than an eyebrow shown on the chapter you have already selected.

SamLanier avatar Oct 11 '22 21:10 SamLanier

Here's a screenshot of what TSPL looks like without the title headings (this PR's change), with chapter abstracts added, and built with current DocC main.

Screen Shot 2022-10-18 at 10 56 38 AM

amartini51 avatar Oct 18 '22 18:10 amartini51

@swift-ci please test

krilnon avatar Oct 31 '22 17:10 krilnon