#332 Collect design discussions in MicroSite development section

aim42 · Aug 15, 2024 · 4e6eee7 · 4e6eee7
1 parent b901699
commit 4e6eee7
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 7 deletions.
diff --git a/src/docs/development/_includes/.jbakeignore b/src/docs/development/_includes/.jbakeignore
@@ -0,0 +1 @@
+Do not render these files directly
diff --git a/src/docs/development/MainLoop-new.puml → ...s/development/_includes/MainLoop-new.puml b/src/docs/development/MainLoop-new.puml → ...s/development/_includes/MainLoop-new.puml
diff --git a/src/docs/development/issue-185.adoc → ...docs/development/_includes/issue-185.adoc b/src/docs/development/issue-185.adoc → ...docs/development/_includes/issue-185.adoc
@@ -15,7 +15,7 @@ writing a new checker, especially should there be
 no central _registry_ of checkers.
 
 Up to v 1.0.0-RC-1 we violated the OCP and allowed
-major redundancies in code:
+major redundancies in the code:
 
 [source,java]
 ----
@@ -33,8 +33,6 @@ class AllCheckers {
 ----
 
 
-
-
 === Solution Approach
 
 A solution needs to address two issues:

diff --git a/src/docs/development/issue-190.adoc → ...docs/development/_includes/issue-190.adoc b/src/docs/development/issue-190.adoc → ...docs/development/_includes/issue-190.adoc
@@ -3,7 +3,6 @@ ifndef::plantumldir[:plantumldir: .plantuml/]
 
 == Refactoring the Main Checking Loop
 
-
 https://github.com/aim42/htmlSanityCheck/issues/190[Issue 190]
 proposes to merge the two classes AllChecksRunner and ChecksRunner.
 
@@ -13,6 +12,3 @@ proposes to merge the two classes AllChecksRunner and ChecksRunner.
 ....
 include::MainLoop-new.puml[]
 ....
-
-
-
diff --git a/src/docs/development/issue-219.adoc → ...docs/development/_includes/issue-219.adoc b/src/docs/development/issue-219.adoc → ...docs/development/_includes/issue-219.adoc
diff --git a/src/docs/development/issue-244.adoc → ...docs/development/_includes/issue-244.adoc b/src/docs/development/issue-244.adoc → ...docs/development/_includes/issue-244.adoc
diff --git a/src/docs/development/issue-252.adoc → ...docs/development/_includes/issue-252.adoc b/src/docs/development/issue-252.adoc → ...docs/development/_includes/issue-252.adoc
diff --git a/src/docs/development/design-discussions.adoc b/src/docs/development/design-discussions.adoc
@@ -0,0 +1,18 @@
+:filename: development/design-decisions.adoc
+:jbake-title: Design Discussions
+:jbake-type: page_toc
+:jbake-status: published
+:jbake-menu: development
+:jbake-order: 20
+== {jbake-title}
+:icons: font
+:toc: right
+:toclevels: 3
+:toc-position: right
+// :experimental:
+
+include::_includes/issue-185.adoc[leveloffset=+1]
+include::_includes/issue-190.adoc[leveloffset=+1]
+include::_includes/issue-219.adoc[leveloffset=+1]
+include::_includes/issue-244.adoc[leveloffset=+1]
+include::_includes/issue-252.adoc[leveloffset=+1]