ReviewOS

also looking at this

stacks/uplink

docs: the documentation the README points at

#63
Merged glennmichael123 wants to merge docs/the-missing-docs into main
9 files +509 -10
9 days ago

Refs #35. Everything except production hosting, which needs a decision from you (below).

The three README lines

resources/views/index.stx was called the dashboard. It is the public page; dashboard.stx is the dashboard, and it calls notFound() so it answers 404 wherever the site is deployed. Both are named now, with that distinction.

The test command was ./pantry/.bin/bun test tests/unit/uplink, which needs a directory a fresh clone does not have. Nothing has been exercising it: CI runs bun run test, which is ./buddy test. That is what the README says now.

The dashboard was described without its URL. It has one.

The Layout section had also drifted past what the issue listed: no License model, no app/Billing/, no docs/.

The docs

Seven pages: index, install, permissions, configuration, security, troubleshooting, uninstall.

Written for whoever is reading, which the issue's own acceptance criteria got wrong. It asks the troubleshooting page to lead with ./buddy uplink:doctor. Someone who downloaded the DMG has no repository and no ./buddy. The first step is the log at ~/Library/Logs/Uplink.log and the menubar checklist; uplink:doctor is offered afterwards as the from-source equivalent.

Uninstall names both Keychain items. There are two under com.stacksjs.uplink: claude-oauth-token and license-key. The issue names only the first, so a page written from its text would leave the licence key behind. Both log files are named too, since the log rotates now.

Security says what a text can actually do: unattended read, write and execute with your permissions, and that an unlocked phone with access to the thread is therefore an open door. And what leaves the Mac, including the licence check to uplink.stacksjs.com every six hours. A security page that omitted that would be worse than no page.

config/docs.ts had an empty nav and a one-item sidebar. Every link now resolves to a page that exists, which I checked, because nothing in the framework verifies that.

What needs you

How the docs reach production. config/cloud.ts declares main and api and nothing else. The issue assumed every deploy builds a docs site; it does not. This project takes the Hetzner/SSH branch of buddy deploy, which has no docs step at all. The AWS branch that does build docs uploads to an S3 bucket this project has no equivalent of.

So today these pages are served by buddy dev at /docs and nowhere else. Getting them onto uplink.stacksjs.com/docs means adding a site to config/cloud.ts, which is an infrastructure change rather than a docs one.

That is the only reason this says Refs rather than Closes.

Verification

pages: 7
config links: 10, missing: 0
broken relative links: 0
dash check done

163 unit tests, buddy lint and buddy typecheck clean.

Facts in the pages are taken from the source rather than from the issue: paths from settings.ts and license.ts, defaults from config/uplink.ts, the filter's rules from filter.ts, the permission strings from config/uplink.ts and codex-engine.ts.

🤖 Generated with Claude Code

9 changed files on the files tab, with 0 review threads.

Sign in to comment on this pull request.