Documentation tip - spaces between includes

[taher]

Hi Documentation team and everyone,

Just a quick tip. I think It might be safer to keep spaces between
"include" directives. If you stack include directives on top of each
other, asciidoctor might get confused especially if the headers in
these documents are of different levels.

So for consistency, I recommend keeping an empty line above and below
any "include" directive to be on the safe side.

Furthermore, I highly recommend reading the asciidoc best practices
[1] page. One item that I myself am not following but I think would be
hugely beneficial is the one-line-per-sentence.

[1] https://asciidoctor.org/docs/asciidoc-recommended-practices/

[Jacques Le Roux]

Le 16/03/2018 à 11:18, Taher Alkhateeb a écrit :

> Hi Documentation team and everyone,
>
> Just a quick tip. I think It might be safer to keep spaces between
> "include" directives. If you stack include directives on top of each
> other, asciidoctor might get confused especially if the headers in
> these documents are of different levels.
>
> So for consistency, I recommend keeping an empty line above and below
> any "include" directive to be on the safe side.
>
> Furthermore, I highly recommend reading the asciidoc best practices
> [1] page. One item that I myself am not following but I think would be
> hugely beneficial is the one-line-per-sentence.
>
> [1] https://asciidoctor.org/docs/asciidoc-recommended-practices/
>

Thanks for these tips Taher

Jacques