docs: bring the humanized root README to main#87
Open
TexablePlum wants to merge 1 commit into
Open
Conversation
- Describe the motivation, features, architecture and current status of the platform - Add a mermaid architecture diagram and stack badges - Link the per-service and contracts READMEs instead of duplicating their content - Credit py-draughts as the foundation of the rule engine - Tests: not applicable, documentation-only change
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
1 participant
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.
What
Docs-only sync of the rewritten root README (motivation, feature summary, mermaid architecture
diagram, status/roadmap, py-draughts credits) so
mainshows it when the repository goes public.Why
mainis the public face; the README rewrite (#86) landed ondevright after the v0.4.0release.
devandmaindiffer only by this document.Verification
Documentation-only; the change went through PR #86 on dev. CI path filters do not trigger on
README changes, so the required checks will not report here - merging needs the admin bypass.