Skip to content

Add a GitHub Pages project site - #9

Merged
mategogiberidze merged 3 commits into
mainfrom
feature/pages-site
Oct 21, 2026
Merged

mategogiberidze merged 3 commits into
mainfrom
feature/pages-site

Conversation

@mategogiberidze

@mategogiberidze mategogiberidze commented Oct 21, 2026 •

Copy link
Copy Markdown
Owner

What does this change?

Adds a small project site for app users at https://meshand.app/, published with GitHub Pages.

  • site/index.html: one static page, no build step and no external requests apart from the GitHub API call for the latest release.
    • What MeshAnd is (radio → MeshAnd over Bluetooth → OsmAnd map), features, who it's for, what you need (Android 7+, a Meshtastic radio such as the T-Beam Supreme, free OsmAnd or Pro), the five install steps with the OsmAnd → Menu → Plugins allow step highlighted, "good to know", and links to the radio guide, changelog, releases, source, developer guide, Discussions, issues and the GPL-3.0 licence.
    • The text comes from README, CHANGELOG and docs/. Chat and Phone GPS have a "Next version" badge plus a note that the current download doesn't have them yet.
    • Brand: the Summit logo (inline SVG and favicon), pine #1F5A47 and ember #F07B4F, a hero phone illustration in the style of the social preview. It follows the system light/dark setting.
    • The download button asks the GitHub API for releases/latest and links straight to the APK ("Download MeshAnd 0.2.0", size and date). If that call fails, it opens the latest release page.
  • Guides under /docs/ (MkDocs Material): site/build.sh renders docs/radio-setup.md, docs/development.md and CHANGELOG.md (as "What's new"), plus a short overview page (site/guides/index.md), with the pine/ember colours, a light/dark switch, search and a contents list. The .md files stay the only source; the build rewrites the one ../CHANGELOG.md link and runs --strict, so a broken link fails the deploy. mkdocs==1.6.1 and mkdocs-material==9.7.7 are pinned in site/requirements.txt. Material is in maintenance mode and doesn't work with MkDocs 2.0, so mkdocs stays below 2.0. The landing page's guide links now open these pages instead of GitHub.
  • .github/workflows/pages.yml: installs the pinned packages, runs site/build.sh and deploys build/site with setup-python@v7, configure-pages@v6, upload-pages-artifact@v5 and deploy-pages@v5. It runs on pushes to main that touch site/**, docs/**, CHANGELOG.md or the workflow file, or by hand. It doesn't touch ci.yml or release.yml.
  • README: a "Website" link in the top link row.
  • AGENTS.md (Build & run): how the site is built, published and previewed, plus a reminder to remove the "Next version" badges when 0.3.0 is released.

Pages is already enabled (Source: GitHub Actions) with the custom domain meshand.app; its DNS records are on Cloudflare (DNS only), and GitHub is issuing the HTTPS certificate. The first deploy runs when this is merged. No release, tag or version change.

Type of change

  • Bug fix
  • New feature
  • UI / design
  • Docs only
  • Build, CI or refactoring

How was it tested?

No app code changed, so the Gradle checks and phone test don't apply (CI runs them anyway).

  • ./site/build.sh builds cleanly with --strict. Served build/site locally and checked the landing page and the guide pages in headless Chrome at 1280 px (light and dark) and in a 375 px phone viewport (dark): no horizontal scroll, the release lookup fills in "Download MeshAnd 0.2.0 · APK, 9.5 MB".
  • The Pages workflow itself runs only on main, so it's first exercised after merge.

Screenshots

The hero uses the same illustration style as docs/images/social-preview.png. The names on the illustration (Nino, Ana, Luka, Giorgi) are made up.

Checklist

  • Doesn't log channel keys, radio configuration or other secrets
  • Doesn't make MeshAnd transmit anything new to the mesh (or this was agreed in a discussion first)
  • User-visible changes are added to CHANGELOG.md under the next version (not an app change)
  • README / docs / AGENTS.md updated if something they say is no longer true
  • AI tools were used for this change: yes

🤖 Generated with Claude Code

One static page in site/ for app users: what MeshAnd does, features
(chat and phone GPS marked as next version), who it's for, what you
need, the install steps including the OsmAnd Plugins allow step, and
links to the guides, releases and licence. Uses the Summit logo and
pine/ember colours, follows the system light/dark setting, and works
at phone width. The download button reads releases/latest from the
GitHub API and falls back to the release page.

pages.yml deploys site/ on pushes to main that touch it, separate
from ci.yml and release.yml.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@claude

claude Bot commented Oct 21, 2026

Copy link
Copy Markdown

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

mategogiberidze and others added 2 commits October 22, 2026 00:31
site/build.sh renders docs/*.md and CHANGELOG.md with MkDocs Material
under /docs/ (pine/ember theme, light/dark switch, search) and puts the
landing page at the root. The Markdown files stay the only source; the
Pages workflow now also runs when docs/ or CHANGELOG.md change.
mkdocs and mkdocs-material are pinned (mkdocs stays below 2.0).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The canonical, Open Graph and MkDocs URLs, the README link and the
guides' link back to the website now use https://meshand.app/.
AGENTS.md records the Cloudflare DNS setup for the domain.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mategogiberidze
mategogiberidze merged commit 28da9c0 into main Oct 21, 2026
2 checks passed
@mategogiberidze
mategogiberidze deleted the feature/pages-site branch October 21, 2026 21:10
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