Skip to content

RF Sentinel (RFSentinel): free, open-source police detector app for Android. Spots police body cams, Flock ALPR cameras, AirTag trackers, Remote ID drones, smart glasses and fake cell towers from Bluetooth LE and WiFi. No root.

8.1 KB
Raw Blame

Website: how to edit and configure

The RF Sentinel website is served by GitHub Pages from the docs/ folder of main. Live at https://cis-c0.github.io/RFSentinel/.

docs/*.html is generated: never edit it by hand. Edit the sources in site/pages/ and rebuild.

Layout

Path What it is
site/pages/*.html Page sources: a metadata comment + the page body (no <head>, header or footer)
tools/build_site.py Build script: shared template (head, nav, header, community tiles, footer, scripts), structured data, sitemap, link checker
docs/*.html Built pages (output, committed)
docs/assets/site.js Shared Q&A deep links and latest-release download links
docs/assets/style.css The only stylesheet (hand-written, edit directly)
docs/assets/fonts/ Share Tech Mono, self-hosted (SIL OFL 1.1, OFL.txt must stay next to it)
docs/assets/og.png 1280×640 social preview image (link cards)
docs/favicon.svg Site icon (the app icon)
docs/robots.txt Allows all crawlers (search engines and AI), points to the sitemap
docs/llms.txt Plain-text summary for AI crawlers / LLMs (hand-written, edit directly)
docs/sitemap.xml Generated by the build
docs/.nojekyll Tells GitHub Pages to serve files as-is (no Jekyll)
docs/screenshots/ Shared with the README; use demo-data screenshots only

docs/ also holds README assets (SIGNATURES.md, the banner SVGs). They are served by Pages too; leave them.

Build

python tools/build_site.py

Python 3 only, no dependencies. It writes every page to docs/, regenerates docs/sitemap.xml, and exits with an error on a broken internal link, image, anchor (page.html#id) or a duplicate Q&A id. Always run it after any change to site/pages/ or tools/build_site.py, and commit the sources and the docs/ output together.

Preview locally:

python -m http.server 8765 --directory docs

then open http://localhost:8765/.

Page source format

<!--META {"title": "...", "description": "...", "nav": "guides", "crumb": "Short name"} -->
<div class="page-head">...</div>
...

META keys (JSON):

  • title (required): the <title>, also used for Open Graph / Twitter. Put the search query people type first, then | RF Sentinel. Plain text; & is fine.
  • description (required): meta description, ~150-300 chars, technical.
  • nav: which top-nav item is highlighted: index, how-it-works, guides, install, android-auto, hardware, qa.
  • crumb: breadcrumb name for structured data (defaults to the title).
  • noindex: true keeps the page out of search and the sitemap (404 only).

The file name is the URL: site/pages/foo.html → /RFSentinel/foo.html. index.html is the home page.

Placeholders replaced in page bodies:

Placeholder Becomes
{{RELEASES}} https://github.com/CIS-C0/RFSentinel/releases/latest
{{REPO}} https://github.com/CIS-C0/RFSentinel
{{DISCORD}} the Discord invite
{{DOWNLOAD_SVG}}, {{GITHUB_SVG}}, {{DISCORD_SVG}} inline icons for buttons

Links between pages are relative (qa.html#detect-flock, install.html). The 404 page uses absolute URLs because GitHub serves it from any path.

Q&A entries (the SEO workhorse)

Every question, on qa.html or any guide page, uses exactly this markup:

<details class="faq" id="unique-kebab-id">
<summary>The question, phrased the way people search it?</summary>
<div>
<p>The answer. Technical, specific, with identifiers in <code>...</code>.</p>
</div>
</details>
  • The build turns every such block into schema.org FAQPage structured data, so the markup must match exactly: class="faq", an id, <summary>, then one wrapping <div>.
  • id must be unique on its page; it's the deep link (qa.html#id opens the answer automatically).
  • On qa.html, questions are grouped in <section class="faq-group" id="..."> with an <h2>; add new groups to the numbered table of contents at the top.
  • The CSS class is faq for historical reasons, but user-facing text always says "Q&A", never "FAQ" (owner's preference).

Writing rules

  • Facts come from the code. Scores, thresholds and identifiers must match detect/SignatureEngine.kt, detect/CellAnalyzer.kt, detect/EvidenceFusion.kt, detect/PatrolCluster.kt, util/Prefs.kt defaults and docs/SIGNATURES.md. When the app changes, update the site.
  • Technical, no marketing fluff. Say what it can't do (limits) as plainly as what it can.
  • No SØPHIA / s0phia mentions on the home page (owner's choice): they live on sophia-alternative.html and in the Q&A only; the home page footer skips that guide.
  • Competitors (SØPHIA etc.): only verifiable facts; write "see vendor" when unknown. Never offer, link or hint at pirated copies. "s0phia for free" questions point to RF Sentinel as the free alternative.
  • No location data: no provinces, cities, local police forces or coordinates (country-level presets like "Canada" / "US" are fine).
  • Never the owner's real name or email. The author is CIS-C0.
  • No analytics, cookies, trackers or third-party fonts/scripts. The only external request is the GitHub API call for the latest release (download button label and direct APK link), which falls back to the releases page.
  • Screenshots: demo data only, never real scans or the owner's real area.

Adding a page

  1. Create site/pages/new-page.html with the META comment.
  2. If it's a guide, add it to GUIDES in tools/build_site.py (footer list), and a card on index.html's Guides grid. Top-nav items live in NAV.
  3. Add it to docs/llms.txt.
  4. Run the build.

Template changes

Header, nav, Discord / GitHub buttons, the community tiles, footer and <head> tags are in TEMPLATE in tools/build_site.py. It's a Python str.format string. Shared browser behavior is in docs/assets/site.js. BASE, REPO, RELEASES and DISCORD are constants at the top.

GitHub Pages configuration

  • Repo Settings → Pages: source Deploy from a branch, branch main, folder /docs. Every push to main redeploys in about a minute.
  • Equivalent API call: gh api -X POST repos/CIS-C0/RFSentinel/pages -f "source[branch]=main" -f "source[path]=/docs"
  • The repo's website field points at the site (gh repo edit CIS-C0/RFSentinel --homepage https://cis-c0.github.io/RFSentinel/).
  • Custom domain (if one is bought later): add docs/CNAME containing the domain, set it in Settings → Pages, enable Enforce HTTPS, and change BASE in tools/build_site.py plus the URLs in docs/robots.txt, docs/llms.txt and the README, then rebuild.

Search engines

  • Google Search Console and Bing Webmaster Tools: the owner verifies the site and submits https://cis-c0.github.io/RFSentinel/sitemap.xml (needs their login; an agent can't do it). Verification by HTML file: drop the file the console gives into docs/ and push.
  • Rich results: Google only shows FAQ rich snippets for some sites now, but the structured data is still read by search engines and AI crawlers.
  • Check structured data with https://validator.schema.org/.

On every app release (checklist)

Every time a new version is published on GitHub Releases, check the website:

  1. Download button: it reads the latest release from the GitHub API and links the asset whose name ends in -release.apk. Keep that asset name (RFSentinel-vX.Y.Z-release.apk) and mark the release as Latest (not a pre-release or draft), or the button falls back to the releases page and loses its version label. After publishing, open the live site and confirm the button shows the new tag and links the new APK.
  2. Content: if the release adds, changes or removes a feature, rule, score, threshold or default, update the matching pages in site/pages/ (and docs/llms.txt), rebuild, and push with the release.
  3. Static numbers: APK size ("about 9 MB" on install.html), Android version requirements, theme count, build tool versions on install.html.

Publishing

The repo is public. Get the owner's explicit OK before pushing site changes to main, like any other push.