Skip to content

doc: advertised doc site on README #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fredbi merged 1 commit into from
Aug 22, 2026
Merged

doc: advertised doc site on README #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions .github/dependabot.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,12 @@ updates:
# hack/genexportdata/bundle have never shown up in a pull request at all.
# A group spans the directories, so this stays one pull request per group.
directories:
- "/"
- "/cmd/genspec-tui"
- "/docs/examples"
- "/testdata"
- "/hack/genexportdata/bundle"
- "**/*"
schedule:
interval: "weekly"
day: "friday"
open-pull-requests-limit: 4
interval: "cron"
cronjob: "35 8 * * 2,5" # => update twice a week
timezone: CEST
open-pull-requests-limit: 24 # => {# modules} x {# groups}
groups:
development-dependencies:
patterns:
Expand Down
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![Release][release-badge]][release-url] [![Go Report Card][gocard-badge]][gocard-url] [![CodeFactor Grade][codefactor-badge]][codefactor-url] [![License][license-badge]][license-url]
<!-- Badges: documentation & support -->
<!-- Badges: others & stats -->
[![GoDoc][godoc-badge]][godoc-url] [![Discord Channel][discord-badge]][discord-url] [![go version][goversion-badge]][goversion-url] ![Top language][top-badge] ![Commits since latest release][commits-badge]
[![Doc][doc-badge]][doc-url] [![GoDoc][godoc-badge]][godoc-url] [![Discord Channel][discord-badge]][discord-url] [![go version][goversion-badge]][goversion-url] ![Top language][top-badge] ![Commits since latest release][commits-badge]

---

Expand All @@ -18,6 +18,8 @@ Supports Go modules (since go1.11).

## Announcements

* **2026-08-21** : landed a new spec generation CLI tool

* **2026-07-31** : landed a new spec generation TUI tool

* **2026-04-19** : large package layout reshuffle
Expand All @@ -28,6 +30,8 @@ Supports Go modules (since go1.11).

API is stable.

[**Complete documentation as github pages**][doc-url]

## Import this library in your project

```cmd
Expand Down Expand Up @@ -168,6 +172,8 @@ Maintainers can cut a new release by either:
[codefactor-badge]: https://img.shields.io/codefactor/grade/github/go-openapi/codescan
[codefactor-url]: https://www.codefactor.io/repository/github/go-openapi/codescan
<!-- Badges: documentation & support -->
[doc-badge]: https://img.shields.io/badge/doc-site-blue?link=https%3A%2F%2Fgo-openapi.github.io%2Fruntime%2F
[doc-url]: https://go-openapi.github.io/runtime
[godoc-badge]: https://pkg.go.dev/badge/github.com/go-openapi/codescan
[godoc-url]: http://pkg.go.dev/github.com/go-openapi/codescan
[discord-badge]: https://img.shields.io/discord/1446918742398341256?logo=discord&label=discord&color=blue
Expand Down
Loading