Reference material that doesn’t fit in the README ’s overview. Each fact has one home; every other page links to it rather than restating it. This page is the map: when a change needs a doc update, CONTRIBUTING.md says which one.
Doc Covers README What it does, host requirements, first-time setup, how a scrape works, and the settings worth knowing first. Compatibility Which redroid image runs which Instagram build, why Android 13, and what was weighed and not shipped. Operations Health, doctor, restarts, manual lock and scrape-now, alerts, the selector-drift canary, memory, storage, backups. FreshRSS Subscribing, feed auth, OPML, push refresh, and running FreshRSS on the same host. Version profiles How per-Instagram-version selector profiles work, and the steps for supporting a new build. Support Where to ask for help, what to include, and what to expect back. OpenAPI spec The feed server’s routes, generated from the code.
Doc Covers Architecture The component map, how a scrape reaches a feed reader, trust boundaries, where state lives, and designs declined. Security policy The threat model, the assurance case, supported versions, and how to report a vulnerability. Incidents Dated write-ups of redroid incidents on the maintainer’s host: symptoms, root causes, recovery, and measurements. Run log Dated device runs behind the version profiles: baselines, validations and probes, with peak memory.
Doc Covers Contributing Development setup, the checks to run, what CI runs, which docs change with what, and pull requests. Testing The test tiers, how to run each, fixtures, coverage, and which tiers CI runs. Releasing The tag scheme, the unattended publish pipeline and its gates, verifying an image, and prereleases. Governance Decision-making, roles, how a change gets in, and continuity for a single-maintainer project. Roadmap Planned work, ordered by scope. Code of conduct Standards for participating in any project space, and how they’re enforced. OpenSSF improvements Where the Scorecard score is capped or still open, and what could move it.