docs: website fixes

Add refinery-gradle-plugins javadocs.
graphs4value · Jul 11, 2024 · e44c541 · e44c541
1 parent 83c1598
commit e44c541
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 28 deletions.
diff --git a/subprojects/docs/build.gradle.kts b/subprojects/docs/build.gradle.kts
@@ -30,6 +30,8 @@ dependencies {
 			}
 		}
 	}
+
+	javadocs(project(":refinery-gradle-plugins", "javadocElements"))
 }
 
 val srcDir = "src"

diff --git a/subprojects/docs/src/components/UseCases/index.tsx b/subprojects/docs/src/components/UseCases/index.tsx
@@ -49,7 +49,7 @@ export default function UseCases() {
               <b>Scenario generation</b> for testing autonomous vechicles
             </>
           }
-          href="https://doi.org/10.1007/s10270-021-00884-z"
+          href="https://doi.org/10.1007/s10270-021-00918-6"
         />
         <UseCase
           icon={<Uc2 />}

diff --git a/subprojects/docs/src/css/custom.css b/subprojects/docs/src/css/custom.css
@@ -80,14 +80,18 @@ code {
   --ifm-navbar-shadow: var(--ifm-global-shadow-lw) !important;
 }
 
-.button, .navbar__link, .footer__link-item, .DocSearch-Button-Placeholder {
+.button, .navbar__link, .footer__link-item {
   text-transform: uppercase;
   font-variation-settings: 'wdth' 87.5;
 }
 
 .DocSearch-Button-Placeholder {
-  padding: 0 9px 0 6px !important;
-  font-family: var(--ifm-font-family-base);
+  font-family: var(--ifm-font-family-base) !important;
+}
+
+.button {
+  /* No decoration even in `::: info` boxes. */
+  text-decoration: none;
 }
 
 .button--play::before {

diff --git a/subprojects/docs/src/develop/javadoc.md b/subprojects/docs/src/develop/javadoc.md
@@ -11,20 +11,21 @@ Here you can find API documentation for Refinery components automatically genera
 
 # Refinery
 
-* [`tools.refinery:refinery-generator`](pathname://refinery-generator)
-* [`tools.refinery:refinery-language`](pathname://refinery-language)
-* [`tools.refinery:refinery-language-ide`](pathname://refinery-language-ide)
-* [`tools.refinery:refinery-language-model`](pathname://refinery-language-model)
-* [`tools.refinery:refinery-language-semantics`](pathname://refinery-language-semantics)
-* [`tools.refinery:refinery-logic`](pathname://refinery-logic)
-* [`tools.refinery:refinery-store`](pathname://refinery-store)
-* [`tools.refinery:refinery-store-dse`](pathname://refinery-store-dse)
-* [`tools.refinery:refinery-store-dse-visualization`](pathname://refinery-store-dse-visualization)
-* [`tools.refinery:refinery-store-query`](pathname://refinery-store-query)
-* [`tools.refinery:refinery-store-query-interpreter`](pathname://refinery-store-query-interpreter)
-* [`tools.refinery:refinery-store-reasoning`](pathname://refinery-store-reasoning)
-* [`tools.refinery:refinery-store-reasoning-scope`](pathname://refinery-store-reasoning-scope)
-* [`tools.refinery:refinery-store-reasoning-smt`](pathname://refinery-store-reasoning-smt)
+* [`tools.refinery:refinery-generator`](pathname://refinery-generator/)
+* [`tools.refinery:refinery-gradle-plugins`](pathname://refinery-gradle-plugins/)
+* [`tools.refinery:refinery-language`](pathname://refinery-language/)
+* [`tools.refinery:refinery-language-ide`](pathname://refinery-language-ide/)
+* [`tools.refinery:refinery-language-model`](pathname://refinery-language-model/)
+* [`tools.refinery:refinery-language-semantics`](pathname://refinery-language-semantics/)
+* [`tools.refinery:refinery-logic`](pathname://refinery-logic/)
+* [`tools.refinery:refinery-store`](pathname://refinery-store/)
+* [`tools.refinery:refinery-store-dse`](pathname://refinery-store-dse/)
+* [`tools.refinery:refinery-store-dse-visualization`](pathname://refinery-store-dse-visualization/)
+* [`tools.refinery:refinery-store-query`](pathname://refinery-store-query/)
+* [`tools.refinery:refinery-store-query-interpreter`](pathname://refinery-store-query-interpreter/)
+* [`tools.refinery:refinery-store-reasoning`](pathname://refinery-store-reasoning/)
+* [`tools.refinery:refinery-store-reasoning-scope`](pathname://refinery-store-reasoning-scope/)
+* [`tools.refinery:refinery-store-reasoning-smt`](pathname://refinery-store-reasoning-smt/)
 
 # Interpreter
 
@@ -34,7 +35,7 @@ The _Refinery Interpreter_ is modified version of [VIATRA&trade;](https://eclips
 
 :::
 
-* [`tools.refinery.interpreter:refinery-interpreter`](pathname://refinery-interpreter)
-* [`tools.refinery.interpreter:refinery-interpreter-localsearch`](pathname://refinery-interpreter-localsearch)
-* [`tools.refinery.interpreter:refinery-interpreter-rete`](pathname://refinery-interpreter-rete)
-* [`tools.refinery.interpreter:refinery-interpreter-rete-recipes`](pathname://refinery-interpreter-rete-recipes)
+* [`tools.refinery.interpreter:refinery-interpreter`](pathname://refinery-interpreter/)
+* [`tools.refinery.interpreter:refinery-interpreter-localsearch`](pathname://refinery-interpreter-localsearch/)
+* [`tools.refinery.interpreter:refinery-interpreter-rete`](pathname://refinery-interpreter-rete/)
+* [`tools.refinery.interpreter:refinery-interpreter-rete-recipes`](pathname://refinery-interpreter-rete-recipes/)
diff --git a/subprojects/docs/src/learn/index.md b/subprojects/docs/src/learn/index.md
@@ -8,4 +8,4 @@ sidebar_position: 0
 
 Various software and systems engineering scenarios rely on the systematic construction of consistent graph models. However, **automatically generating a diverse set of consistent graph models** for complex domain specifications is challenging. First, the graph generation problem must be specified with mathematical precision. Moreover, graph generation is a computationally complex task, which necessitates specialized logic solvers.
 
-**Refinery is a novel open-source software framework** to automatically synthesize a diverse set of consistent domain-specific graph models. The framework offers an expressive high-level specification language using partial models to succinctly formulate a wide range of graph generation challenges. It also provides a modern cloud-based architecture for a scalable _Graph Solver as a Service,_ which uses logic reasoning rules to efficiently synthesize a diverse set of solutions to graph generation problems by partial model refinement. Applications include system-level architecture synthesis, test generation for modeling tools or traffic scenario synthesis for autonomous vehicles.
+**Refinery is an open-source software framework** for the automated synthesis of a diverse set of consistent domain-specific graph models. The framework offers an expressive high-level specification language using partial models to succinctly formulate a wide range of graph generation challenges. It also provides a modern cloud-based architecture for a scalable _Graph Solver as a Service,_ which uses logic reasoning rules to efficiently synthesize a diverse set of solutions to graph generation problems by partial model refinement. Applications include system-level architecture synthesis, test generation for modeling tools or traffic scenario synthesis for autonomous vehicles.
diff --git a/subprojects/docs/src/learn/language/classes/index.md b/subprojects/docs/src/learn/language/classes/index.md
@@ -129,7 +129,7 @@ import ReferencesOppositeSelf from './ReferencesOppositeSelf.svg';
 
 ### Multiplicity
 
-_Multiplicity constrains_ can be provided after the reference type in square braces.
+_Multiplicity constraints_ can be provided after the reference type in square braces.
 They specify how many _outgoing_ references should exist for any given instance of the class.
 
 :::info
@@ -150,7 +150,7 @@ If the multiplicity constraint is omitted, the bound `[0..1]` is assumed.
 
 In the following model, the node `v1` satisfies all multiplicity constraints of `outgoingTransition`.
 The node `v2` violates the lower bound constraint, while `v3` violates the upper bound constraint.
-All `Transition` instances satisfy the multiplicity constrains associated with `source`.
+All `Transition` instances satisfy the multiplicity constraints associated with `source`.
 
 ```refinery
 class Vertex {
@@ -209,4 +209,5 @@ import ContainmentInstance from './ContainmentInstance.svg';
 
 <ContainmentInstance />
 
-Containment edges form trees, while non-containment references, such as `target`, may point across the containment hierarchy.
+Containment edges form must form a forest.
+In contrast, non-containment references, such as `target`, may cross the containment hierarchy.
diff --git a/subprojects/docs/src/plugins/remarkPosix2Windows.ts b/subprojects/docs/src/plugins/remarkPosix2Windows.ts
@@ -2,11 +2,11 @@
  * Copyright (c) Facebook, Inc. and its affiliates.
  * Copyright (c) 2024 The Refinery Authors
  *
- * SPDX-License-Identifier: EPL-2.0
+ * SPDX-License-Identifier: MIT AND EPL-2.0
  *
  * This file is based on
  * https://github.com/facebook/docusaurus/blob/e4ecffe41878728acff55a8370bd7440706c02f7/packages/docusaurus-remark-plugin-npm2yarn/src/index.ts
- * but was changed to conver shell commands to POSIX to Windows syntax.
+ * but was changed to convert shell commands to POSIX to Windows syntax.
  */
 
 import type { Code, Literal } from 'mdast';