Skip to content

Feature/update documentation #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 29 commits into from
Feb 5, 2025
Merged

Feature/update documentation #29

merged 29 commits into from
Feb 5, 2025

Conversation

oswaldsql
Copy link
Owner

This pull request includes several updates to the README.md file and the addition of new Architecture Decision Records (ADRs) for the MiniMock project. The changes improve documentation clarity, add a table of contents, and introduce new ADRs to document important architectural decisions.

Improvements to README.md:

  • Added a table of contents for better navigation and readability.
  • Corrected typos and improved consistency in terminology (e.g., "summery" to "summary", "Maitinance" to "Maintenance").
  • Enhanced examples and explanations for various features, including fluent interface, simple return values, and async methods. [1] [2] [3]
  • Added a link to the documentation.

New Architecture Decision Records (ADRs):

  • Introduced ADRs to document key architectural decisions, including general and feature-specific ADRs.
  • Added ADRs for unsupported features, such as extension methods, sealed classes, and static members. [1] [2] [3]
  • Detailed decisions on supporting classes and interfaces, creating mocks, supporting constructors, and events. [1] [2] [3] [4]

@oswaldsql oswaldsql merged commit 218a92b into main Feb 5, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant