docs: lead with {repos, #{...}} map form everywhere#115
Merged
Conversation
The map-of-maps form is the v2.0 idiom. Updates README, getting-started, MIGRATION-2.0, and kura_repo moduledoc to lead with it for both single- and multi-repo configs. The flat 1.x form still works but moves to a 'legacy / back-compat' section.
🟢 Code Coverage — 91.6%2170 of 2368 lines covered. ✅ ELP LintNo diagnostics. ℹ️ 11 OTP CVEs auto-ignored (already fixed in running version)These CVEs are patched in the installed OTP version but NVD data
|
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.
Summary
Updates README, getting-started, MIGRATION-2.0, and
kura_repomoduledoc to lead with the v2.0{repos, #{...}}map-of-maps form for both single-repo and multi-repo configs.The flat 1.x form (
{repo, _}/{host, _}/{user, _}) still works but is now in a 'legacy / back-compat' section, not the primary example.Why
The map form is the v2.0 idiom: single-repo today, forward-compatible if you add a second backend later. Showing the flat form as default signaled 'v1.x with extras' instead of the real v2.0 story.
Test plan
rebar3 fmt --checkcleanrebar3 compileclean