From b930cd5ff34a3dd009899930c9a85df5736d19d0 Mon Sep 17 00:00:00 2001 From: Lars Reimann Date: Fri, 12 Apr 2024 20:43:35 +0200 Subject: [PATCH] docs: restructure "Development" section (#1033) ### Summary of Changes * Group testing related pages together * Add link to contributing page --- .../{ => testing}/call-graph-testing.md | 0 .../{ => testing}/formatting-testing.md | 0 .../{ => testing}/generation-testing.md | 0 .../{ => testing}/grammar-testing.md | 0 .../partial-evaluation-testing.md | 0 .../{ => testing}/scoping-testing.md | 0 .../{ => testing}/typing-testing.md | 0 .../{ => testing}/validation-testing.md | 0 docs/mkdocs.yml | 67 ++++++++++--------- 9 files changed, 35 insertions(+), 32 deletions(-) rename docs/development/{ => testing}/call-graph-testing.md (100%) rename docs/development/{ => testing}/formatting-testing.md (100%) rename docs/development/{ => testing}/generation-testing.md (100%) rename docs/development/{ => testing}/grammar-testing.md (100%) rename docs/development/{ => testing}/partial-evaluation-testing.md (100%) rename docs/development/{ => testing}/scoping-testing.md (100%) rename docs/development/{ => testing}/typing-testing.md (100%) rename docs/development/{ => testing}/validation-testing.md (100%) diff --git a/docs/development/call-graph-testing.md b/docs/development/testing/call-graph-testing.md similarity index 100% rename from docs/development/call-graph-testing.md rename to docs/development/testing/call-graph-testing.md diff --git a/docs/development/formatting-testing.md b/docs/development/testing/formatting-testing.md similarity index 100% rename from docs/development/formatting-testing.md rename to docs/development/testing/formatting-testing.md diff --git a/docs/development/generation-testing.md b/docs/development/testing/generation-testing.md similarity index 100% rename from docs/development/generation-testing.md rename to docs/development/testing/generation-testing.md diff --git a/docs/development/grammar-testing.md b/docs/development/testing/grammar-testing.md similarity index 100% rename from docs/development/grammar-testing.md rename to docs/development/testing/grammar-testing.md diff --git a/docs/development/partial-evaluation-testing.md b/docs/development/testing/partial-evaluation-testing.md similarity index 100% rename from docs/development/partial-evaluation-testing.md rename to docs/development/testing/partial-evaluation-testing.md diff --git a/docs/development/scoping-testing.md b/docs/development/testing/scoping-testing.md similarity index 100% rename from docs/development/scoping-testing.md rename to docs/development/testing/scoping-testing.md diff --git a/docs/development/typing-testing.md b/docs/development/testing/typing-testing.md similarity index 100% rename from docs/development/typing-testing.md rename to docs/development/testing/typing-testing.md diff --git a/docs/development/validation-testing.md b/docs/development/testing/validation-testing.md similarity index 100% rename from docs/development/validation-testing.md rename to docs/development/testing/validation-testing.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 690c37f0b..130f7a084 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -11,41 +11,43 @@ exclude_docs: | nav: - Home: - - README.md + - README.md - Language: - - language/README.md - - Pipeline Language: - - language/pipeline-language/README.md - - Pipelines: language/pipeline-language/pipelines.md - - Segments: language/pipeline-language/segments.md - - Statements: language/pipeline-language/statements.md - - Expressions: language/pipeline-language/expressions.md - - Common: - - language/common/README.md - - Comments: language/common/comments.md - - Packages: language/common/packages.md - - Imports: language/common/imports.md - - Parameters: language/common/parameters.md - - Results: language/common/results.md - - Types: language/common/types.md - - Variance: language/common/variance.md - - Stub Language: - - language/stub-language/README.md - - Classes: language/stub-language/classes.md - - Global Functions: language/stub-language/global-functions.md - - Enumerations: language/stub-language/enumerations.md - - Annotations: language/stub-language/annotations.md - - Type Parameters: language/stub-language/type-parameters.md + - language/README.md + - Pipeline Language: + - language/pipeline-language/README.md + - Pipelines: language/pipeline-language/pipelines.md + - Segments: language/pipeline-language/segments.md + - Statements: language/pipeline-language/statements.md + - Expressions: language/pipeline-language/expressions.md + - Common: + - language/common/README.md + - Comments: language/common/comments.md + - Packages: language/common/packages.md + - Imports: language/common/imports.md + - Parameters: language/common/parameters.md + - Results: language/common/results.md + - Types: language/common/types.md + - Variance: language/common/variance.md + - Stub Language: + - language/stub-language/README.md + - Classes: language/stub-language/classes.md + - Global Functions: language/stub-language/global-functions.md + - Enumerations: language/stub-language/enumerations.md + - Annotations: language/stub-language/annotations.md + - Type Parameters: language/stub-language/type-parameters.md - Standard Library: stdlib/ - Development: - - Call Graph Testing: development/call-graph-testing.md - - Formatting Testing: development/formatting-testing.md - - Generation Testing: development/generation-testing.md - - Grammar Testing: development/grammar-testing.md - - Partial Evaluation Testing: development/partial-evaluation-testing.md - - Scoping Testing: development/scoping-testing.md - - Typing Testing: development/typing-testing.md - - Validation Testing: development/validation-testing.md + - Testing: + - Call Graph Testing: development/testing/call-graph-testing.md + - Formatting Testing: development/testing/formatting-testing.md + - Generation Testing: development/testing/generation-testing.md + - Grammar Testing: development/testing/grammar-testing.md + - Partial Evaluation Testing: development/testing/partial-evaluation-testing.md + - Scoping Testing: development/testing/scoping-testing.md + - Typing Testing: development/testing/typing-testing.md + - Validation Testing: development/testing/validation-testing.md + - Contributing 🌐: https://github.com/Safe-DS/DSL/contribute # Configuration of MkDocs & Material for MkDocs -------------------------------- @@ -71,6 +73,7 @@ theme: accent: indigo features: - content.code.copy + - content.tabs.link - content.tooltips - navigation.indexes - navigation.instant