diff --git a/docs/Home.md b/docs/ArDoCo.md similarity index 94% rename from docs/Home.md rename to docs/ArDoCo.md index 651127659..6c39b9b81 100644 --- a/docs/Home.md +++ b/docs/ArDoCo.md @@ -1,15 +1,14 @@ +
-# ArDoCo - ArDoCo (Architecture Documentation Consistency) is a framework to connect architecture documentation and models while identifying missing or deviating elements (inconsistencies). An element can be any representable item of the model, like a component or a relation. To do so, ArDoCo first creates trace links and then makes use of them and other information to identify inconsistencies. -You can find ArDoCo on the [website](ardoco.de) and [on GitHub](https://github.com/ArDoCo). +You can find ArDoCo on the [website](https://ardoco.de) and [on GitHub](https://github.com/ArDoCo). Before contributing, please read the [Quickstart Guide](quickstart). @@ -18,10 +17,10 @@ Before contributing, please read the [Quickstart Guide](quickstart). To get to know the project, please read the following pages: * [Core Pipeline Definition](pipeline) -* [Intermediate Artifacts](intermediateartifacts) +* [Intermediate Artifacts](intermediate-artifacts) * [Text Preprocessing Microservice](Text-Preprocessing-Microservice) -* [Traceability Link Recovery (TLR)](tlr) -* [Inconsistency Detection (ID)](inconsistencydetection) +* [Traceability Link Recovery (TLR)](traceability-link-recovery) +* [Inconsistency Detection (ID)](inconsistency-detection) * [Linking Sketches and Software Architecture (LiSSA)](LiSSA) ## Project Structure diff --git a/docs/InconsistencyDetection.md b/docs/Inconsistency-Detection.md similarity index 92% rename from docs/InconsistencyDetection.md rename to docs/Inconsistency-Detection.md index 735af75bd..ef8f23f23 100644 --- a/docs/InconsistencyDetection.md +++ b/docs/Inconsistency-Detection.md @@ -1,4 +1,3 @@ -# Inconsistency Detection Currently, there are two kinds of inconsistencies that are supported by the approach: Missing Model Elements (MMEs) and Undocumented Model Elements (UMEs). @@ -7,7 +6,7 @@ Our heuristic looks for model elements that do not have any (or below a certain In the configuration options, you can fine tune the threshold as well as set up a regex-based whitelist. Missing Model Elements (MMEs) are architecture elements that are described within the SAD that cannot be traced to the SAM. -For this, we make use of the recommendations from the Recommendation Generator within the [Traceability Link Recovery (TLR)](tlr). +For this, we make use of the recommendations from the Recommendation Generator within the [Traceability Link Recovery (TLR)](traceability-link-recovery). Each of these recommendations that are not linked with a model element are potential inconsistencies. To further increase precision, we make use of filters. For example, we use a filter to get rid of commonly used software (development) terminology that look similar to, e.g., components but rarely are model elements. diff --git a/docs/IntermediateArtifacts.md b/docs/Intermediate-Artifacts.md similarity index 99% rename from docs/IntermediateArtifacts.md rename to docs/Intermediate-Artifacts.md index 5352e09c6..da69ec7f5 100644 --- a/docs/IntermediateArtifacts.md +++ b/docs/Intermediate-Artifacts.md @@ -1,4 +1,3 @@ -# Intermediate Artifacts Currently, there are three kinds of intermediate artifacts. First, the input text has an internal representation (cf. [edu/kit/kastel/mcse/ardoco/core/api/text/Text.java](https://github.com/ArDoCo/Core/blob/main/framework/common/src/main/java/edu/kit/kastel/mcse/ardoco/core/api/text/Text.java)) to cover all the annotations from the preprocessing. diff --git a/docs/Pipeline.md b/docs/Pipeline.md index 9c9781eb7..ee5900b99 100644 --- a/docs/Pipeline.md +++ b/docs/Pipeline.md @@ -1,4 +1,3 @@ -# Pipeline ```mermaid classDiagram diff --git a/docs/Quickstart.md b/docs/Quickstart.md index 3d879e426..78a4a20aa 100644 --- a/docs/Quickstart.md +++ b/docs/Quickstart.md @@ -1,3 +1,4 @@ + The ArDoCo is a maven project and can be embedded by using its specs (from the [pom](https://github.com/ArDoCo/Core/blob/main/pom.xml)). Please acknowledge the [code of conduct](https://github.com/ArDoCo/Core/blob/main/CODE_OF_CONDUCT.md). diff --git a/docs/Text-Preprocessing-Microservice.md b/docs/Text-Preprocessing-Microservice.md index 9acfca221..5d5466828 100644 --- a/docs/Text-Preprocessing-Microservice.md +++ b/docs/Text-Preprocessing-Microservice.md @@ -1,4 +1,3 @@ -# Text Preprocessing Microservice Text preprocessing works locally, but there is also the option to host a **microservice** for this. The benefit is that the models do not need to be loaded each time, saving some runtime (and local memory). diff --git a/docs/TLR.md b/docs/Traceability-Link-Recovery.md similarity index 96% rename from docs/TLR.md rename to docs/Traceability-Link-Recovery.md index 139c2480f..fddf6de94 100644 --- a/docs/TLR.md +++ b/docs/Traceability-Link-Recovery.md @@ -1,10 +1,9 @@ -# Traceability Link Recovery There are currently three kinds of TLR approaches that we describe in their corresponding sections: * [Software Architecture Documentation (SAD) to Model (SAM)](#sad-sam) * [Software Architecture Model (SAM) to Code](#sam-code) -* [SAD to Code via SAM](SAD-SAM-Code-TLR) +* [SAD to Code via SAM](#sad-sam-code) ## SAD-SAM diff --git a/docs/_Sidebar.md b/docs/_Sidebar.md index 6fb077806..8fc557d3b 100644 --- a/docs/_Sidebar.md +++ b/docs/_Sidebar.md @@ -1,15 +1,15 @@ # Table of Contents -1. [Home](home) +1. [Home](ardoco) 2. [Quickstart](quickstart) 3. [Pipeline](pipeline) -4. [Intermediate Artifacts](intermediateartifacts) +4. [Intermediate Artifacts](intermediate-artifacts) 1. [SAM](IntermediateArtifacts#software-architecture-models) 1. [Code](IntermediateArtifacts#code) 5. [Text Preprocessing Microservice](Text-Preprocessing-Microservice) -6. [Traceability Link Recovery (TLR)](tlr) - 1. [SAD-SAM](tlr#sad-sam) - 1. [SAM-Code](tlr#sam-code) - 1. [SAD-SAM-Code](tlr#sad-sam-code) -7. [Inconsistency Detection (ID)](InconsistencyDetection) +6. [Traceability Link Recovery (TLR)](traceability-link-recovery) + 1. [SAD-SAM](traceability-link-recovery#sad-sam) + 1. [SAM-Code](traceability-link-recovery#sam-code) + 1. [SAD-SAM-Code](traceability-link-recovery#sad-sam-code) +7. [Inconsistency Detection (ID)](Inconsistency-Detection) 8. [LiSSA](lissa) \ No newline at end of file