Skip to content

docs: refine README intro and add database dump guidance#25

Merged
vitormattos merged 2 commits into
mainfrom
docs/readme-intro-and-setup-guidance
May 14, 2026
Merged

docs: refine README intro and add database dump guidance#25
vitormattos merged 2 commits into
mainfrom
docs/readme-intro-and-setup-guidance

Conversation

@vitormattos
Copy link
Copy Markdown
Member

This PR improves the README onboarding flow before the setup tutorial.

Changes:

  • Add a concise project introduction at the top
  • Make wording environment-agnostic and more natural
  • Replace the awkward full-sentence prerequisite link with a cleaner Docker prerequisite sentence
  • Add a dedicated Database dump section with automatic import behavior and manual import command

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos vitormattos force-pushed the docs/readme-intro-and-setup-guidance branch from 37f5e76 to 2c1e163 Compare May 14, 2026 01:52
@vitormattos vitormattos merged commit b340a4e into main May 14, 2026
2 checks passed
@vitormattos vitormattos deleted the docs/readme-intro-and-setup-guidance branch May 14, 2026 01:55
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