diff --git a/docToolRec.adoc b/docToolRec.adoc index 3152efd..29440f4 100644 --- a/docToolRec.adoc +++ b/docToolRec.adoc @@ -4,16 +4,38 @@ - - - _2023-05-14 13:48:53 Draft documentation tool option comparisons_ -==== I. Main Deliverables +==== I. Introduction + -. A documentation entry system with source files under version control -. A process that creates a web accessible documentation site from the source repository -. A CI/CD pipeline that triggers the re-publication process on a push to the source repository ==== II. Requirements What features of Confluence are used in our wiki content? Are there counterparts in the other options under consideration? +Specific Items +. A documentation entry system with source files under version control +. A process that creates a web accessible documentation site from the source repository +. Triggering site re-publication process on a push to the source repository (CI/CD pipeline) +. Support for one or more of the available markdown languages for ducument creation +. Essential feature support +.. Tables +.. Liats, nested lists, bullet or numbered style +.. Table of contents +.. Task list items +.. Definition lists +.. Footnotes +.. Bibliographies +.. Callouts (e.g. NOTE, WARN...) +.. Support for reader comments +.. Support for user-defined macros +.. Support for common diagram styles (via Kroki) +.. Conditional markup +.. External file includes +.. Substitutes punctuations with typographic entities +.. Github emojis + + + ==== III. Static site generators as documentation substrate . MkDocs