Skip to content

docs: improve Docker Hub README clarity and consistency#1568

Merged
SebConejo merged 1 commit intomainfrom
replace-docker-readme
Apr 15, 2026
Merged

docs: improve Docker Hub README clarity and consistency#1568
SebConejo merged 1 commit intomainfrom
replace-docker-readme

Conversation

@SebConejo
Copy link
Copy Markdown
Member

@SebConejo SebConejo commented Apr 15, 2026

Summary

  • Replace "setup wizard" language with "sign up" + "first account becomes admin" to match manifest.build/docs
  • Break the review-before-running section into separate copyable commands inside a collapsible <details> card
  • Make Option 2 (Docker Compose) and Option 3 (Docker Run) more explicit about what the user should actually do
  • Add "Give it about 30 seconds to boot" note (matches docs)
  • Replace "TypeORM migrations" with "database migrations" (users don't need to know the ORM)

Test plan

  • Verify Markdown renders correctly on GitHub (collapsible card, code blocks, tables)
  • Spot-check that all install commands match the actual files in 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.

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
Copy link
Copy Markdown

codecov bot commented Apr 15, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.94%. Comparing base (158cbaf) to head (c8e8f34).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           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           
Flag Coverage Δ
frontend 97.93% <ø> (ø)
shared 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

@SebConejo SebConejo merged commit acd3284 into main Apr 15, 2026
9 checks passed
@SebConejo SebConejo deleted the replace-docker-readme branch April 15, 2026 00:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant