docs: Refactor architecture into dedicated file#26
Merged
Conversation
- Create comprehensive docs/architecture.md (650+ lines) - Extract detailed architecture from README.md into architecture.md - Simplify README.md (221 → 167 lines) - Remove EnterpriseDB copyright/license section - Update docs/INDEX.md with architecture.md reference - Add clear navigation between README and architecture docs Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
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.
Summary
Extract detailed architecture content from README.md into a comprehensive dedicated
architecture document, making the README more concise and scannable.
Changes
New File: docs/architecture.md (650+ lines)
Complete architecture documentation covering:
Component Details:
Network Connectivity:
Data Flow:
Additional Topics:
Updated: README.md
Reduced from 221 lines to 167 lines (-25%)
Improvements:
Retained:
Updated: docs/INDEX.md
Architecture section enhanced:
Benefits
For New Users
For Technical Users
For Maintainers
File Changes
Standards Compliance
Testing
Checklist
Ready to merge - Significantly improves documentation organization and README readability.