divviup/public-docs

Public facing documentation for Divvi Up.

public-docs's Issues

BYOH guide

Write a guide for setting up a helper and connecting it with Divvi Up.

Might be tricky due to the need for internet routability. Should we suggest use of ngrok?

E2E quickstart guide

Write a guide that covers the bare minimum setup of Divvi Up, including onboarding, task creation, writing a client, and data collection.

Branch protection on `gh-pages` doesn't include administrators

Admins can bypass the branch protection rules on gh-pages, which allows for accidental direct pushes to that branch. We can't enable bypass protection because deployment happens through deploy key, which acts as an administrator.

The root of the problem is that GitHub has poor support for making GitHub Actions-only branches. See https://github.com/orgs/community/discussions/13836. There are some workarounds available, such as using a GitHub App or bot-only account for deploys and allowing it to bypass protection.

Threat Model

Write and publish a formal, user-facing threat model for Divvi Up. This will likely be a superset of the DAP threat model.

E2E collection guide

How to use collect.rs, and the janus_collector library.

Set up search

https://docusaurus.io/docs/search