Repository navigation
docs: landing page and docs site on GitHub Pages - #16
Merged
Merged
Conversation
MkDocs Material site built from docs/ with a custom landing page, plus getting-started, proxy and configuration pages. Root SECURITY, CONTRIBUTING and CHANGELOG are pulled in by a small hook that also rewrites repo-relative links. A Pages workflow builds with --strict on PRs and deploys on push to main. Adds make docs / docs-serve. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011Da3omLMubz5WPXbMRK7r2
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01X9CEjRcHsJmgWdtz6ZTKsk
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
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.
Requested by Adeel · project thread
What
Before: Tether's docs only exist as Markdown in the repo.
After: a landing page and searchable docs site at https://adeelahmad.github.io/Tether/, with a hero, feature cards, a 30-second quickstart, the how-it-works diagram and the comparison table, then Getting started, Guides (proxy, MCP, WebDriver, remote UI, policies), Reference (configuration, architecture, security) and Project (contributing, changelog). Light/dark mode, works on phones.
Why
Requested in the project thread: a static site plus docs hosted on GitHub Pages.
How
mkdocs.ymlat the root,docs/stays the source. Existing docs pages are unchanged and still read well on GitHub.website/hooks.pypulls rootSECURITY.md,CONTRIBUTING.md,CHANGELOG.mdinto site pages and rewrites repo-relative links, so nothing is duplicated.website/overrides/home.html+docs/assets/extra.css..github/workflows/pages.ymlbuilds with--stricton PRs touching docs, and deploys viaactions/deploy-pageson push tomain.make docs/make docs-serve; README gets a Docs badge; CHANGELOG entry.One-time setting: Settings → Pages → Source: GitHub Actions.
How tested
mkdocs build --strictclean locally[Unreleased])Security
🤖 Generated with Claude Code
https://claude.ai/code/session_011Da3omLMubz5WPXbMRK7r2
Generated by Claude Code