docs: improve Docker Hub README clarity and consistency#1568
Merged
Conversation
Align install instructions with manifest.build/docs: replace "setup wizard" with "sign up" language, clarify that the first account becomes admin, add "30 seconds to boot" note. Break the review-before-running section into separate copyable commands inside a collapsible card. Make Option 2 and Option 3 more explicit about what the user should do.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1568 +/- ##
=======================================
Coverage 97.94% 97.94%
=======================================
Files 118 118
Lines 8616 8616
Branches 3242 3242
=======================================
Hits 8439 8439
Misses 175 175
Partials 2 2
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
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
<details>cardTest plan
docker/Summary by cubic
Improve the Docker Hub README for clarity and consistency with manifest.build/docs. Switch “setup wizard” to “sign up” (first account is admin), add a 30s boot note, turn the review-before-running flow into copyable steps inside a collapsible card, make Docker Compose/Run steps explicit, replace “TypeORM migrations” with “database migrations,” and tighten up tables and wording.
Written for commit c8e8f34. Summary will update on new commits.