Skip to content

docs: fix minor documentation issues#3159

Open
pierluigilenoci wants to merge 1 commit intoalibaba:masterfrom
pierluigilenoci:cs/fix-docs-minor
Open

docs: fix minor documentation issues#3159
pierluigilenoci wants to merge 1 commit intoalibaba:masterfrom
pierluigilenoci:cs/fix-docs-minor

Conversation

@pierluigilenoci
Copy link

Summary

Fix three minor documentation issues:

  1. quick-start.md: Remove duplicate $ prompt in command example ($ $ java$ java)
  2. README.md: Use HTTPS instead of HTTP for isitmaintained.com badge URLs (4 occurrences)
  3. push-docker.yaml: Fix misleading step name from "Checkout gh-pages branch" to "Checkout master branch" (the step actually checks out master)

Test plan

  • Documentation-only changes, no functional impact

- quick-start.md: remove duplicate '$' prompt in command example
- README.md: use HTTPS for isitmaintained.com badge URLs
- push-docker.yaml: fix step name from 'Checkout gh-pages branch'
  to 'Checkout master branch' to match actual checkout target

Signed-off-by: Pierluigi Lenoci <pierluigi.lenoci@gmail.com>
@pierluigilenoci
Copy link
Author

Hi @hengyunabc, @HollowMan6 — this PR fixes minor documentation issues: a duplicated $ prompt in the quick-start guide, HTTP→HTTPS links for isitmaintained.com badges in README, and a misleading branch name comment in the Docker push workflow. Would you be willing to review? Thank you!

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