iFixedX documentation

iFixedX is an experimental web client and ranking lab for X (Twitter)-shaped timelines: transparent scoring, a dual-pipeline ingest (Live X API + background Grok), and local control via RxDB in the browser.

The product is not affiliated with X Corp. It uses documented APIs and your own keys on your server.

In this documentation

Area

Start here

New to the project

Getting started

Run locally / deploy

Run locally · Rebuild docs · Publish docs

UI & routing

UI shell · URL parameters

Mixer & Pipetrix pipeline

Mixer pipeline

Environment variables

Environment

Platform contracts

Canonical contracts

Full platform map & roadmap

Platform map · Roadmap

How this documentation is organized

This site follows the Diátaxis structure (same pattern as Ubuntu Desktop docs and the P1Start Sphinx site).

  • Tutorials — first-time setup: API, sign-in, first timeline load.

  • How-to guides — tasks: wipe local DB, switch timeline source, publish docs.

  • Reference — env vars, API routes, RxDB collections, file map.

  • Explanation — architecture, fairness philosophy, Grok vs local ranker.

  • Canonical contracts — stable names and data-flow rules (update here first, then code).

Web & mobile scope

Surface

Status

Web (desktop)

Primary — classic X three-column and wide “stream” layout

Web (narrow)

Responsive rails; stream layout for Explore-style reading

Mobile web

Same SPA; touch targets and single-column feed at small breakpoints

Native apps

Out of scope for this repo; contracts here are API/RxDB-centric

Contributing to docs

Edit Markdown under docs/. Build with:

cd docs && pip install -r requirements.txt && make html

See Rebuild docs and Publish docs site for build output and docs.liveandletdev.com.