docs: convert AsciiDoc to Markdown (closes #6023)#7757
Open
knoal wants to merge 1 commit intoIntersectMBO:masterfrom
Open
docs: convert AsciiDoc to Markdown (closes #6023)#7757knoal wants to merge 1 commit intoIntersectMBO:masterfrom
knoal wants to merge 1 commit intoIntersectMBO:masterfrom
Conversation
Convert top-level AsciiDoc documentation to GitHub-Flavored Markdown so
links render correctly on GitHub.
* README.adoc -> README.md
* CONTRIBUTING.adoc -> CONTRIBUTING.md
* RELEASE.adoc -> RELEASE.md
* STYLEGUIDE.adoc -> STYLEGUIDE.md
Update cross-references in:
* DESCRIPTION.md
* plutus-benchmark/marlowe/README.md
* .github/copilot-instructions.md
Drop *.adoc target from scripts/check-broken-links.sh.
Conversion done with downdoc; output reviewed and adjusted for
asciidoc-specific markup (link:[...], {outfilesuffix}, anchor-style
headings).
Closes IntersectMBO#6023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Convert the four top-level AsciiDoc documents to GitHub-Flavored Markdown so that links render correctly on GitHub (per #6023):
README.adoc->README.mdCONTRIBUTING.adoc->CONTRIBUTING.mdRELEASE.adoc->RELEASE.mdSTYLEGUIDE.adoc->STYLEGUIDE.mdCross-references updated in:
DESCRIPTION.mdplutus-benchmark/marlowe/README.md.github/copilot-instructions.mdscripts/check-broken-links.shno longer targets*.adoc.How
downdoc.{outfilesuffix}placeholders replaced with.md.# URL[label]to# [label](URL)..adoc/asciidocreferences except an unrelated third-party URL insidedoc/notes/multi-currency/bibliography.bib.Notes for reviewers
#user-documentation) match the converted heading slugs and resolve on GitHub.Closes #6023