Restructure README as Docker Hub overview#170
Merged
Conversation
Add a Quick start section with a 4.0 pull/run example, split image variants into production and development, and move build/CI notes to a Contributing section so the README works as the Docker Hub description as well. Refresh listed patch versions (4.0.4, 3.4.9, 3.3.11) and drop EOL 3.2/3.1 entries. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Restructures README.md to read as a Docker Hub project overview: adds a Quick start section, reorganizes the production/development image explanation, refreshes the image tag listings (bumps patch versions, drops the 3.1 and 3.2 series from the supported list), and reorganizes build/trigger/schedule instructions under a single Contributing section. This is intended to pair with PR #169, which syncs the README to Docker Hub on master pushes.
Changes:
- Rewrite intro, add Quick start, and tighten the production vs development image description.
- Update listed patch versions (4.0.0→4.0.4, 3.4.8→3.4.9, 3.3.10→3.3.11) and remove 3.2/3.1 entries; treat EOL versions as a compatibility-only Misc category.
- Consolidate "How to build", "Build and push", and "Scheduled build workflow" sections under a new
## Contributingheading with subsections.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Test for #169