Moving documentation around to limit folder clutter

oswaldsql · oswaldsql · commit 8867397e1210 · 2024-11-03T12:24:31.000+01:00
diff --git a/docs/ADR/README.md b/docs/ADR/README.md
@@ -6,15 +6,14 @@ All the ADRs have been approved and are considered final decisions for the proje
 
 ## General ADRs
 
-- [Do We __Really__ Need a New Mocking Framework?](DoWeNeedANewMockingFramework.md) - Deciding whether to build a new mocking framework.
-- [Matching Target API in Mock API](MatchingTargetApi.md) - Ensures the mock API closely mirrors the target API.
-- [How Strict Should MiniMock Be?](HowStrictShouldMiniMockBe.md) - Deciding how strict the framework should be.
-- [No Built-in Assertion Feature](NoBuiltInAssertionFeature.md) - Users choose their preferred assertion framework.
-- [No Dependencies to Shared Libraries](NoDependencies.md) - Avoid dependencies on shared libraries.
-- [Documentation and Examples](DocumentationAndExamples.md) - Approach to documentation and examples for the framework.
-- [Logging and Debugging](LoggingAndDebugging.md) - Approach to logging and debugging within the framework.
-- [Allowing Skipping Arguments in Mock Setup](SupportSkippingArguments.md) - Allows skipping arguments in mock setups for flexibility.
-- [Creating Mocks](CreatingMocks.md) - Decision on how to create mocks in the framework.
+- [Do We __Really__ Need a New Mocking Framework?](general/DoWeNeedANewMockingFramework.md) - Deciding whether to build a new mocking framework.
+- [Matching Target API in Mock API](general/MatchingTargetApi.md) - Ensures the mock API closely mirrors the target API.
+- [How Strict Should MiniMock Be?](general/HowStrictShouldMiniMockBe.md) - Deciding how strict the framework should be.
+- [No Built-in Assertion Feature](general/NoBuiltInAssertionFeature.md) - Users choose their preferred assertion framework.
+- [No Dependencies to Shared Libraries](general/NoDependencies.md) - Avoid dependencies on shared libraries.
+- [Documentation and Examples](general/DocumentationAndExamples.md) - Approach to documentation and examples for the framework.
+- [Logging and Debugging](general/LoggingAndDebugging.md) - Approach to logging and debugging within the framework.
+- [Creating Mocks](general/CreatingMocks.md) - Decision on how to create mocks in the framework.
 
 ## Feature Specific ADRs
 
@@ -25,6 +24,7 @@ All the ADRs have been approved and are considered final decisions for the proje
 - [Support for Events](feature/SupportForEvents.md) - Decision on supporting events in the mocking framework.
 - [Support for Indexers](feature/SupportForIndexers.md) - Decision on supporting indexers in the mocking framework.
 - Special cases
+  - [Allowing Skipping Arguments in Mock Setup](general/SupportSkippingArguments.md) - Allows skipping arguments in mock setups for flexibility.
   - [Support for Protected Methods](feature/SupportingProtectedMethods.md) - Decision on whether to support mocking protected methods.
   - [Support for Generic Methods (WIP)](feature/SupportForGenericMethods.md) - Decision on supporting generic methods in the mocking framework.
   - [Support for Asynchronous Methods (WIP)](feature/SupportForAsynchronousMethods.md) - Handling asynchronous methods in the mocking framework.
diff --git a/docs/ADR/feature/SupportForClassesAndInterfaces.md b/docs/ADR/feature/SupportForClassesAndInterfaces.md
@@ -2,11 +2,13 @@
 
 ## Context
 
-In the MiniMock framework, there is a need to determine the scope of support for mocking different types of members. While interfaces are the primary focus due to their flexibility and common usage in dependency injection, there is also a need to support classes to cover a broader range of use cases.
+In the MiniMock framework, there is a need to determine the scope of support for mocking different types of members. 
+While interfaces are the primary focus due to their flexibility and common usage in dependency injection, there is also a need to support classes to cover a broader range of use cases.
 
 ## Decision
 
-The MiniMock framework will primarily focus on supporting interfaces but will also include support for classes. This approach ensures that the framework can be used in a wide variety of scenarios, providing flexibility and comprehensive mocking capabilities.
+The MiniMock framework will primarily focus on supporting interfaces but will also include support for classes. 
+This approach ensures that the framework can be used in a wide variety of scenarios, providing flexibility and comprehensive mocking capabilities.
 
 ## Consequences
 
@@ -20,7 +22,6 @@ The MiniMock framework will primarily focus on supporting interfaces but will al
 
 - **Complexity**: Adding support for classes may introduce additional complexity in the framework.
 - **Maintenance**: Requires ongoing maintenance to ensure both interfaces and classes are supported effectively.
-f mocking scenarios.
 
 ---
 
diff --git a/docs/ADR/feature/SupportForConstructors.md b/docs/ADR/feature/SupportForConstructors.md
@@ -2,13 +2,16 @@
 
 ## Context
 
-In the MiniMock framework, there is a need to determine the scope of support for mocking constructors. Initially, the framework will support only classes with parameterless constructors. This decision simplifies the initial implementation and allows for a gradual introduction of more complex constructor support.
+In the MiniMock framework, there is a need to determine the scope of support for mocking constructors. Initially, the framework will support only classes with parameterless constructors. 
+This decision simplifies the initial implementation and allows for a gradual introduction of more complex constructor support.
 
 ## Decision
 
-The MiniMock framework will initially support mocking only classes with parameterless constructors. A plan for adding support for classes with parameterized constructors is being developed and will be implemented in future iterations.
+The MiniMock framework will initially support mocking only classes with parameterless constructors. 
+A plan for adding support for classes with parameterized constructors is being developed and will be implemented in future iterations.
 
-Since the main focus of the framework is to provide a simple and easy-to-use mocking solution for interfaces and classes, the decision to start with parameterless constructors aligns with this goal. See ADR [Support For Classes and Interfaces](SupportForClassesAndInterfaces.md) for more information.
+Since the main focus of the framework is to provide a simple and easy-to-use mocking solution for interfaces and classes, 
+the decision to start with parameterless constructors aligns with this goal. See ADR [Support For Classes and Interfaces](SupportForClassesAndInterfaces.md) for more information.
 
 ## Consequences
 
diff --git a/docs/ADR/feature/SupportSkippingArguments.md b/docs/ADR/feature/SupportSkippingArguments.md
@@ -22,4 +22,4 @@ We will allow the skipping of arguments when setting up mocks for methods. This
 
 ---
 
-More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.
+More ADRs can be found in the [docs/ADR](../README.md) directory.
diff --git a/docs/ADR/general/CreatingMocks.md b/docs/ADR/general/CreatingMocks.md
@@ -23,4 +23,4 @@ Mocks will be created using a mock factory. The mock factory will provide a cent
 
 ---
 
-More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.
+More ADRs can be found in the [docs/ADR](../README.md) directory.
diff --git a/docs/ADR/general/DoWeNeedANewMockingFramework.md b/docs/ADR/general/DoWeNeedANewMockingFramework.md
@@ -25,4 +25,4 @@ We will develop a new mocking framework, MiniMock, that focuses on providing a m
 
 ---
 
-More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.
+More ADRs can be found in the [docs/ADR](../README.md) directory.
diff --git a/docs/ADR/general/DocumentationAndExamples.md b/docs/ADR/general/DocumentationAndExamples.md
@@ -42,4 +42,4 @@ Accepted
 
 ---
 
-More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.
+More ADRs can be found in the [docs/ADR](../README.md) directory.
diff --git a/docs/ADR/general/HowStrictShouldMiniMockBe.md b/docs/ADR/general/HowStrictShouldMiniMockBe.md
@@ -23,4 +23,4 @@ The framework will be strict, throwing exceptions when a member that is not mock
 
 ---
 
-More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.
+More ADRs can be found in the [docs/ADR](../README.md) directory.
diff --git a/docs/ADR/general/LoggingAndDebugging.md b/docs/ADR/general/LoggingAndDebugging.md
@@ -32,4 +32,4 @@ Accepted
 
 ---
 
-More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.
+More ADRs can be found in the [docs/ADR](../README.md) directory.
diff --git a/docs/ADR/general/MatchingTargetApi.md b/docs/ADR/general/MatchingTargetApi.md
@@ -1,10 +1,12 @@
 ﻿# Matching Target API in Mock API
 
-When creating a mocking class, the mock API must closely mirror the API of the target being mocked. This ensures that the mock can be used as a drop-in replacement for the target, facilitating seamless testing and reducing the learning curve for developers.  
+When creating a mocking class, the mock API must closely mirror the API of the target being mocked. 
+This ensures that the mock can be used as a drop-in replacement for the target, facilitating seamless testing and reducing the learning curve for developers.  
 
 ## Decision
 
-The mock API should reflect the target API with minimal additional methods. The mock should only include methods that already exist in the target API, ensuring consistency and ease of use.  
+The mock API should reflect the target API with minimal additional methods. 
+The mock should only include methods that already exist in the target API, ensuring consistency and ease of use.  
 
 ## Status
 
@@ -23,4 +25,4 @@ Accepted
 
 ---
 
-More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.
+More ADRs can be found in the [docs/ADR](../README.md) directory.
diff --git a/docs/ADR/general/NoBuiltInAssertionFeature.md b/docs/ADR/general/NoBuiltInAssertionFeature.md
@@ -23,4 +23,4 @@ We will not include a built-in assertion feature in our mocking framework. Inste
 
 ---
 
-More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.
+More ADRs can be found in the [docs/ADR](../README.md) directory.
diff --git a/docs/ADR/general/NoDependencies.md b/docs/ADR/general/NoDependencies.md
@@ -25,4 +25,4 @@ We will not include any dependencies on shared libraries in our project. Instead
 
 ---
 
-More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.
+More ADRs can be found in the [docs/ADR](../README.md) directory.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1,6 +1,6 @@
 ﻿title: MiniMock
 logo: Troll.jpg
 description: Minimalistic approach to mocking in .NET
-remote_theme: pages-themes/modernist@v0.2.0
+remote_theme: pages-themes/hacker@v0.2.0
 plugins:
   - jekyll-remote-theme # add this line to the plugins list if you already have one

Original file line number	Diff line number	Diff line change
`@@ -22,4 +22,4 @@ We will allow the skipping of arguments when setting up mocks for methods. This`
`22`	`22`
`23`	`23`	`---`
`24`	`24`
`25`		`-More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.`
	`25`	`+More ADRs can be found in the [docs/ADR](../README.md) directory.`
Original file line number	Diff line number	Diff line change
`@@ -23,4 +23,4 @@ Mocks will be created using a mock factory. The mock factory will provide a cent`
`23`	`23`
`24`	`24`	`---`
`25`	`25`
`26`		`-More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.`
	`26`	`+More ADRs can be found in the [docs/ADR](../README.md) directory.`
Original file line number	Diff line number	Diff line change
`@@ -25,4 +25,4 @@ We will develop a new mocking framework, MiniMock, that focuses on providing a m`
`25`	`25`
`26`	`26`	`---`
`27`	`27`
`28`		`-More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.`
	`28`	`+More ADRs can be found in the [docs/ADR](../README.md) directory.`
Original file line number	Diff line number	Diff line change
`@@ -42,4 +42,4 @@ Accepted`
`42`	`42`
`43`	`43`	`---`
`44`	`44`
`45`		`-More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.`
	`45`	`+More ADRs can be found in the [docs/ADR](../README.md) directory.`
Original file line number	Diff line number	Diff line change
`@@ -23,4 +23,4 @@ The framework will be strict, throwing exceptions when a member that is not mock`
`23`	`23`
`24`	`24`	`---`
`25`	`25`
`26`		`-More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.`
	`26`	`+More ADRs can be found in the [docs/ADR](../README.md) directory.`
Original file line number	Diff line number	Diff line change
`@@ -32,4 +32,4 @@ Accepted`
`32`	`32`
`33`	`33`	`---`
`34`	`34`
`35`		`-More ADRs can be found in the [docs/ADR](../ADR/README.md) directory.`
	`35`	`+More ADRs can be found in the [docs/ADR](../README.md) directory.`