Add Quick Start and License docs pages#4
Merged
Conversation
Quick Start is a clone-free, step-by-step guide: an instant certificate check via `go run …@latest`, then `go install` for a `certel` command, then the continuous monitor with a minimal config. License states MIT and links to the repository LICENSE file. Both are surfaced in the landing cards.
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.
Adds two documentation pages under
docs/content/.Quick Start (
quick-start.md, weight 5)A pointedly step-by-step, clone-free getting-started guide:
go run github.com/antonkomarev/certel/cmd/certel@latest check example.com, no clone and no build (needs Go 1.24+ forgo run pkg@version). Shows the real JSON verdict.go install …@latestto get a plaincertelonPATH.config.yaml.certel validate-config/certel monitor.Plus a
notification-sinksection to watch alerts flow.The commands were verified end-to-end locally against the live repo (remote
go runresolves and runs; the sample check output is from a real run).License (
license.md, weight 90)States MIT plainly and links to the repository
LICENSE.Landing page
Both pages appear automatically in the auto-derived sidebar; also added a Quick Start card to
_index.md.