Skip to content

Housekeeping/documentation#356

Merged
cjimti merged 4 commits intomasterfrom
housekeeping/documentation
Jan 1, 2026
Merged

Housekeeping/documentation#356
cjimti merged 4 commits intomasterfrom
housekeeping/documentation

Conversation

@cjimti
Copy link
Copy Markdown
Member

@cjimti cjimti commented Jan 1, 2026

Description

Add Open Graph and Twitter Card meta tags to improve social media link previews. Previously, sharing kubefwd.com on social platforms showed a generic icon and outdated description. Now it displays the kubefwd masthead image with an updated description highlighting TUI, REST API, and MCP features.

Also fixes site_url from the old GitHub Pages URL to kubefwd.com.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • Test improvement (new or updated tests)
  • Documentation update
  • Stability/performance improvement
  • Build/CI improvement

Note: New features are developed by maintainers only. See CONTRIBUTING.md for details.

Related Issues

N/A - Housekeeping improvement

Testing

  • Ran mkdocs build --strict locally - builds successfully
  • Verified meta tags appear in generated HTML
  • After deploy, validate with Twitter Card Validator and Facebook Debugger

Checklist

  • My code follows the project's style guidelines (go fmt, go vet)
  • I have read CONTRIBUTING.md
  • I have updated documentation if needed
  • This PR is focused and does not include unrelated changes

Changes

mkdocs.yml:

  • site_url: https://txn2.github.io/kubefwdhttps://kubefwd.com
  • site_description: Updated to mention TUI, REST API, MCP, and unique local IPs

docs/overrides/main.html (new file):

  • Open Graph meta tags (og:type, og:url, og:title, og:description, og:image)
  • Twitter Card meta tags (summary_large_image format)
  • Uses existing kubefwd-masthead.jpg as social preview image

Before/After

Before: Generic document icon, outdated "bulk port forwarding" description

After: Branded masthead image, description highlighting modern features (TUI, REST API, MCP)

- Updated `site_url` and `site_description` in `mkdocs.yml` to reflect the new project scope.
- Added Open Graph and Twitter meta tags in `overrides/main.html` for better link previews.
@cjimti cjimti merged commit f259e34 into master Jan 1, 2026
12 checks passed
@cjimti cjimti deleted the housekeeping/documentation branch January 1, 2026 19:33
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.

1 participant