8356
Wx
www-xonecas-io / files
www-xonecas-io / tickets / 1044-no-readme.md
2.9 KB
1--- 2id: 1044 3title: No README 4type: chore 5status: done 6priority: p2 7created: 2026-11-08T15:45:06Z 8updated: 2026-11-08T20:16:19Z 9source: human 10area: docs 11moves: 2026-11-08T15:45:24Z inbox doing drag; 2026-11-08T15:46:39Z doing review agent; 2026-11-08T16:01:02Z review todo drag; 2026-11-08T18:15:52Z todo doing drag; 2026-11-08T18:19:52Z doing review agent; 2026-11-08T20:16:19Z review done drag 12--- 13 14 15## Notes 16 17- 2026-11-08 15:45Z (agent): Triage: chore, p2, area docs. This repo has no README.md at its root. Without one, its project page would have no description once 1041 adds it to the site, and the only usage docs are bin/site help (1042). It isn't a bug: nothing is broken. Question: should the README cover only using the site (bin/site, pushing repos, make serve), or also how the code is laid out? 18 19- 2026-11-08 15:46Z (agent): Added README.md at the repo root: what the site is, a diagram of push/import → index → build → public/, how to start (make site, import, index, serve), managing repos, overrides.txt rules and the code layout. It closes 1045 too. I picked the scope myself, since the question was open: usage plus a short layout table. Checked: each command and path in it against the Makefile, help and code (make -n index build, remote list gives 105). Not checked: how it renders as a project page, which waits on 1041. 20 21- 2026-11-08 18:15Z (human): Read me is wrong: 22 23 [sacenox@vm www-xonecas-io]$ git remote add origin sean@xonecas.io:www-xonecas-io.git 24 [sacenox@vm www-xonecas-io]$ git push -u origin main 25 The authenticity of host 'xonecas.io (145.14.158.227)' can't be established. 26 ED25519 key fingerprint is: SHA256:zKSDwFDlL5gkXMiWr4tHHP3a5KpcXL6UwkAM7ko/cdg 27 This key is not known by any other names. 28 Are you sure you want to continue connecting (yes/no/[fingerprint])? yes 29 Warning: Permanently added 'xonecas.io' (ED25519) to the list of known hosts. 30 sean@xonecas.io's password: 31 fatal: 'www-xonecas-io.git' does not appear to be a git repository 32 fatal: Could not read from remote repository. 33 34 Please make sure you have the correct access rights 35 and the repository exists. 36 37- 2026-11-08 18:19Z (agent): Fixed the push section, which was wrong in the way your push showed. It skipped the one server step and used <user>@ and a hand-written authorized_keys line. It now says: once per key, on the server as the git user, make site && bin/site key add laptop.pub, then git push git@xonecas.io:<name>.git from any machine. It also says what the password prompt and 'does not appear to be a git repository' mean. The table row uses git@xonecas.io too. Details and the SSH test are on 1042. I checked every command in the README against the code. The push itself I only tested against a local sshd, not xonecas.io. 38 39- 2026-11-08 18:29Z (agent): README updated again for 1042: the push setup is now two lines that make bin/site the git user's login shell. Password or any key works, and the key add step is gone.