Re: [PATCH] Doc: fix misleading asciidoc formating
- From
Jeff King <peff@peff.net>
- Date
- Mar 5, 2019, 23:11 UTC
- Message-ID
- <20190305231142.GA359@sigill.intra.peff.net>
- In-Reply-To
- <20190305230227.GA22901@sigill.intra.peff.net>
On Tue, Mar 05, 2019 at 06:02:27PM -0500, Jeff King wrote:
Show 12 quoted lines
> On Wed, Mar 06, 2019 at 07:54:20AM +0900, Junio C Hamano wrote: > > > Jeff King <peff@peff.net> writes: > > > > > Did you notice this when building locally, or on the asciidoctor-built > > > pages at git-scm.com? > > > > Does git-scm.com even have this file rendered? I do not think we > > glob for technical/*.txt in any of our Makefiles; instead we have a > > list of ready-to-be-consumed TECH_DOCS listed explicitly. > > It is rendered, at https://git-scm.com/docs/directory-rename-detection.
By the way, that rendering shows that the whole document could probably use a few tweaks to make its asciidoc formatting look good (in addition to the "x." thing that Jean-Noël fixed here, which can also be seen there).
TBH, I still have mixed feelings on rendering these technical docs with asciidoc at all. It seems like few enough people bother to render them that bugs persist for a long time. It kind of seems like make-work getting them to format correctly.
-Peff