[jira] [Updated] (CAMEL-12708) We should use atx-style section titles in docs

["Andrea Cosentino (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/CAMEL-12708?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Andrea Cosentino updated CAMEL-12708:
-------------------------------------
    Fix Version/s: 3.0.0

> 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
>             Fix For: 3.0.0
>
>          Time Spent: 20m
>  Remaining Estimate: 0h
>
> [https://asciidoctor.org/docs/asciidoc-recommended-practices/#section-titles]
> Currently many docs in Camel uses the Setext style for section headings:
> {code:java}
> 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 instead:
> {code:java}
> === Architecture
> {code}



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)