docs(readme): add user deployment guide - #7
Merged
Conversation
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
Add a user-facing deployment guide to both README files.
Motivation
The existing documentation focused on contributors and technical details. Non-developers need a short, direct path to run Terminal Blog manually or with Docker.
Implementation
Behavior and compatibility
Documentation-only change. No runtime, API, configuration, or data-format changes.
Risk
No application risk. The guide explicitly warns against the default root password and destructive
docker compose down -v.Verification
npx prettier --check README.md README.en.mdgit diff --checkScreenshots or recordings
Not applicable; this pull request changes documentation only.
Checklist