Open ViToni opened 3 months ago
We can convert the CHANGELOG to AsciiDoc but since https://marketplace.visualstudio.com only supports Markdown, we need to keep the README in Markdown (or use https://github.com/opendevise/downdoc to convert from AsciiDoc to Markdown before publishing to https://marketplace.visualstudio.com/items?itemName=asciidoctor.asciidoctor-vscode).
My goal is to move the documentation to Antora (https://github.com/asciidoctor/asciidoctor-vscode/tree/master/docs) and keep a minimal README (in Mardown or AsciiDoc). Migrating the documentation to Antora also allows me to test Antora support in the VS Code extension and improve it at the same time as I migrate the documentation 😄
I forgot that we are using the CHANGELOG.md content in the GitHub release page so we will also need to convert it from AsciiDoc to Markdown when we create the release. See: https://github.com/asciidoctor/asciidoctor-vscode/blob/master/tasks/release-notes.js + https://github.com/asciidoctor/asciidoctor-vscode/blob/master/release.sh
Thanks for sharing the background information (I was really wondering why the Markdown has been in place for so long 🙈). Maybe it'd be better to close the ticket and PR then.
This PR converts README / CHANGELOG to AsciiDoc.
Note:
git
is able to keep track of renames but only if there are only few changes involved while renaming.git
would treat the respective files as "new" when the PR gets squashed.Resolves #865.