asam-ev / qc-framework

Mozilla Public License 2.0
15 stars 8 forks source link

AsciiDoc based user documentation #17

Open andreaskern74 opened 7 months ago

andreaskern74 commented 7 months ago

Is your feature request related to a problem? Please describe.

Currently, the user documentation is written in Markdown, which is fast to maintain, but strongly limited regarding layout and cross-referencing.

All other current ASAM projects using AsciiDoc based on a common guide. This leads to a harmonized view of all documents and a harmonized styling. And it resolves all limitations from Markdown.

Describe the solution you'd like

See ASAM Editorial Guide and other ASAM projects as reference.

andreaskern74 commented 2 months ago

After the hackathon, we probably need to reject that --> CCB.