docs: Scaffold official documentation site (#996)#1009
Open
Majdi-Zlitni wants to merge 1 commit intoardalis:mainfrom
Open
docs: Scaffold official documentation site (#996)#1009Majdi-Zlitni wants to merge 1 commit intoardalis:mainfrom
Majdi-Zlitni wants to merge 1 commit intoardalis:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation Refactoring Summary
1. Created
design-decisions.mdThe sections "Goals", "Design Decisions and Dependencies", and "Patterns Used" were extracted from the large root
README.mdand moved into a dedicated file:design-decisions.md.This document now explains why specific architectural choices were made, such as the use of:
Separating these decisions makes the architecture easier to understand and maintain.
2. Created
getting-started.mdAll setup instructions and development guidance were moved from the root
README.mdinto a new file:getting-started.md.This includes:
This keeps the onboarding documentation focused and easier for new developers to follow.
3. Simplified the Root
README.mdThe root
README.mdwas trimmed to remove the detailed getting started and architecture explanations.Instead, it now ends with a clear Documentation section directing users to the official resources.