Skip to content

docs(readme): link to docs.fallout.build (#191)#194

Merged
ChrisonSimtian merged 1 commit into
mainfrom
docs/191-readme-link-to-docs-site
May 26, 2026
Merged

docs(readme): link to docs.fallout.build (#191)#194
ChrisonSimtian merged 1 commit into
mainfrom
docs/191-readme-link-to-docs-site

Conversation

@ChrisonSimtian
Copy link
Copy Markdown
Owner

Summary

Closes #191 — surfaces the live docs site (https://docs.fallout.build/) from the GitHub README, which currently has zero references to it.

Two additions, both above-the-fold:

  1. Centered "📖 Documentation" callout right under the logo — primary discovery surface for first-time visitors landing on the repo from a search hit or share link.
  2. "Docs" shields.io badge in the badge cluster — same visual weight as the CI / NuGet / .NET / License badges.

No other doc-section references in the README needed retargeting — the migration link at line 5 / line 37 stays as a relative path so it works for people browsing on GitHub.

Test plan

Refs

Adds two README references to the live docs site at https://docs.fallout.build/:

- A centered "📖 Documentation" callout right under the logo — most prominent
  surface for first-time visitors landing on the GitHub repo.
- A "Docs" shields.io badge in the badge cluster — visual cue alongside the
  existing CI / NuGet / .NET / License badges.

Closes #191. The remaining done-when items from #41 (broken-link cleanup #192,
Algolia search #193) are tracked separately.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@ChrisonSimtian ChrisonSimtian merged commit 992fcb8 into main May 26, 2026
1 check passed
@ChrisonSimtian ChrisonSimtian deleted the docs/191-readme-link-to-docs-site branch May 26, 2026 08:42
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.

Link to docs.fallout.build from README

1 participant