[
https://issues.apache.org/jira/browse/CAMEL-12708?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Tadayoshi Sato updated CAMEL-12708:
-----------------------------------
Summary: We should use atx-style section titles in docs (was: We should
use atx-style section tiles in docs)
> We should use atx-style section titles in docs
> ----------------------------------------------
>
> Key: CAMEL-12708
> URL: https://issues.apache.org/jira/browse/CAMEL-12708
> Project: Camel
> Issue Type: Improvement
> Components: documentation
> Reporter: Tadayoshi Sato
> Priority: Major
>
> https://asciidoctor.org/docs/asciidoc-recommended-practices/#section-titles
> Currently many docs in Camel uses the Setext style for section headings:
> {code}
> Architecture
> ~~~~~~~~~~~~
> {code}
> However this style has at least a couple of problems:
> # It requires the exactly same number of underline characters as the title
> text; otherwise it renders poorly
> # It is not very intuitive to know the level of a section
> As some docs already use it, we should use the Atx style all over the docs:
> {code}
> === Architecture
> {code}
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
