search

JavaMoney / jsr354-ri

JSR 354 - Moneta: Reference Implementation
Other
344 stars 101 forks source link

Migrate userguide from AsciiDoc to MarkDown #306

Closed stokito closed 5 years ago

stokito commented 5 years ago

In scope of #293 I proposed to convert the userguide from AsciiDoc to Markdown and here is a PR with the change. What we lost during the conversion:

  1. TOC table of content: we can leave without them
  2. Automatic paragraph numbers: not sure if they are needed at all
  3. Description of code snippets: I replaced them with italic text before the code block.

What we got instead: more friendly format that is more popular so it will be easier to contribute.

This change is Reviewable

atsticks commented 5 years ago

Well, I personally do not agree with this change. I don't see any reason to change the documentation format. Also the point on "popularity" I do not agree looking at the people I know. Other opinions? @keilw

keilw commented 5 years ago

Wasn't the User Guide a GitBook? I would keep that in its format.

keilw commented 5 years ago

@atsticks, @otaviojava what are your opinions? In doubt we could just do a quick thumbs up/down here to decide how to handle this PR.

msgilligan commented 5 years ago

I'm a big AsciiDoc fan (and occasional contributor) -- and was happy to see JavaMoney using it.