docs: add runnable getting-started examples to README#17
Closed
ryans-posthog wants to merge 1 commit intomasterfrom
Closed
docs: add runnable getting-started examples to README#17ryans-posthog wants to merge 1 commit intomasterfrom
ryans-posthog wants to merge 1 commit intomasterfrom
Conversation
The Quick start section previously only linked out to external tutorials. Add a short Examples subsection with copy-pasteable commands for the most common entry points: file-server, reverse-proxy, Caddyfile run, validate/reload, and admin API inspection. Generated-By: PostHog Code Task-Id: 182a3d0a-ffdd-4706-802f-9102ffb8fdd0
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
1 participant
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
README.mdwith an### Examplessubsection containing copy-pasteable commands.caddy file-server,caddy reverse-proxy, running from aCaddyfile(caddy run/caddy start),caddy validate+caddy reload, and inspecting the admin API onlocalhost:2019.No other README sections are touched, and no new files are added.
Test plan
README.mdon GitHub (or in a local markdown previewer) and confirm the new### Examplessubsection sits under## Quick startwith all five fenced blocks intact.cd cmd/caddy && go build) and smoke-test each snippet — each should run without "unknown flag" / "unknown command" errors.curl http://localhost:2019/config/returns the live config once Caddy is running.