Home

proton-pulse-web wiki

Documentation for the proton-pulse-web repo and the website at proton-pulse.com.

For the Decky Loader plugin (architecture, system design, developer guide), see the decky-proton-pulse wiki.

Get involved

New contributor? Start here:

1. Read the Developer Guide for local setup and the pre-push gate.
2. Read the Web Deploy Workflow for how feature branches flow through staging before hitting production.
3. Open PRs against staging, not main. main is production only, and every user-facing change is verified on the staging site before promotion.
4. Run make gh-staging to preview at https://mdeguzis.github.io/proton-pulse-web-staging/. The About page shows the deployed version + short SHA so you can confirm the build.
5. Look through the open issues for something to pick up, or file one describing what you want to do.

Pages

• Restore Runbook - if the current maintainer walks away tomorrow, this is the page a stranger reads to bring the whole stack back up on their own account and infra
• Developer Guide - local setup, pre-push gate, staging workflow, all Makefile targets
• Secrets and Environment - every secret this project reads (Supabase edge fns, GitHub Actions, Discord webhooks), where each lives, and how to rotate
• Workflow Dispatch Inputs - standardized app_ids / issue_id / dry_run inputs across every pipeline workflow, plus the back-comment paper trail
• Security Guardrails - passive safety nets: attachment scanner that hash-lookups + hides + labels suspicious uploads on issues + PR comments
• Web Deploy Workflow - end-to-end release flow: feature branches, staging, and production; branching and issue rules
• Caching and Cache Busting - how ?v= content hashes invalidate browser and CDN caches, the service worker image cache (cache-first + stale-while-revalidate) with its admin hit-rate analytics, and how to verify a deploy
• Data Pipeline - GitHub Actions CI/CD pipeline that builds and deploys game data
• Store APIs and Images - Steam / GOG / Epic API endpoints, header image URL chains, content descriptors for the adult filter, and the store URL parser
• Steam Depot Data - how SteamDB gets per-OS depot dates, what PICS actually returns, and our staged plan to replicate it (steamcmd nightly -> manifest_id history -> persistent PICS listener). Consult before any depot / version / manifest work
• Delisted Detection - multi-signal detection of Steam apps that have been pulled from the store
• Steam Library and Drafts - signed-in user features: Steam library sync, verified-owner attestation, cloud report drafts, replaced-appid detection
• API Reference - Supabase REST endpoints and query shapes used by the site and plugin
• Supabase Voting - voting table schemas, RLS, and TrackedConfig fields
• Steam Auth Flow - Steam sign-in flow used by the static site
• Content Moderation - automated moderation pipeline, admin roles, and flagged report handling
• Report Notes Formatting - inline macros (spoiler tags) supported in report notes
• Design Palette - color palette, typography, and UI component reference
• Site Design Principles - layout/grouping rules: cards, subheads, highlight banners