import-style-guide/README.md
Maxim Reznik 181c366690 Add an empty line before :::note admonitions
to avoid broken notes after applying `yarn format`.
2022-09-26 13:49:31 +03:00

29 lines
767 B
Markdown

# Scripts to fetch Ada Quality and Style Guide wikibook
These scripts convert the WiKi book to ada-lang.io markdown.
## Build and run
You need `pandoc`, `curl`, `sed` installed. Build a pandoc filter with Alire:
alr build
Then run:
./fetch.sh <OUTPUT_DIR>
Then run `yarn format` in ada-lang.io repository to reformat output according
to Docusaurus style.
## To be fixed
* Arrange code blocks in Source Code Presentation in two columns
* Add chapter/section numbers
* Replace "see Guideline X.Y.Z{,/and X.Y.Z}", "Chapter X", "Sections X.Y" with cross links
* change definition lists? (in Portability, OOP)
* Fix Wikipedia links
* Fix examples in Reusability:
"Compare the body for the simplest version"
* Fix ACES in References
* Fix Bibliography