Is your feature request related to a problem? Please describe.
The Starknet docs are authored in AsciiDoc, and use Antora to generate the site on docs.starknet.io.
AsciiDoc syntax is similar to Markdown, and as simple as Markdown to get started, but it has a small learning curve for many similar features. For example, headings, italics, links, and source code formatting differ from Markdown syntactically.
Potentially, Markdown-savvy contributors without experience writing in AsciiDoc might be intimidated by AsciiDoc, in spite of its simplicity and similarity to Markdown.
For many features, AsciiDoc is forgiving of Markdown syntax, but not for all. The syntax you must change is listed in the table under the Comparison by example section in the Asciidoctor documentation.
Describe the solution you'd like
You can use Kramdown AsciiDoc to automate the migration from Markdown to AsciiDoc.
One potential solution: The pull_request.yml file, or some other Github workflow, has a step that receives a markdown (.md
) file when saved to a modules/<module_name>/pages
subdirectory, runs kramdown, which converts the markdown file to AsciiDoc, and adds it to the nav.adoc in modules/<module_name>/nav.adoc
.
Before implementing a workflow, someone needs to test Kramdown, preferably with a few relatively complex Markdown files from the Starknet Book or the Cairo Book.
Describe alternatives you've considered
The best long-term solution is for contributors to learn the correct syntax and author files directly in AsciiDoc. In case learning independently is too intimidating, then 1 or 2 community calls can provide the necessary training.