Repository navigation
docs(archivist): add a documents page, from photo to answer - #279
Merged
Merged
Conversation
The user guide covers filing and asking in two short sections written for people who already run famstack. The new page tells the whole flow in five steps: send a photo to the Documents Room, what the archivist replies, the to-dos and dates it takes from a letter, asking months later, and where the documents are stored. It closes with the hardware it needs, German included. The German page is written for German households, with the German topics and an FAQ. The user guide and the docs index link to both.
A sixth step on the documents page, English and German: filed facts go into the family memory and its wiki pages, famstack learns the names around the family and matches new documents against them, and answers draw on all of it.
Three screenshots per language from the Simpsons rig: the letter sent to the Documents Room, the archivist's reply in the thread, and a question answered from a policy filed months earlier. The quoted replies are now the real ones, and step 5 asks the insurance question the archivist answers today.
Element's dark theme, as in the other screenshots and videos; the light ones had large bright areas. The English replies are quoted from the new run that the screenshots show.
arthware-dev
added a commit
that referenced
this pull request
Oct 20, 2026
- `docs/use/documents.md` tells the whole documents flow for a newcomer: photograph a document, send it to the Documents Room, the archivist's reply, the to-dos and dates it takes from a letter, asking months later, where the documents are stored, and the hardware it needs. `docs/de/use/documents.md` is the German page, written for German households, with a short FAQ (Paperless-ngx, cloud, German documents). - Three screenshots per language from the test rig with the fabricated Simpson family, in Element's dark theme (`docs/assets/documents-*.png`). The replies quoted on the pages are the real ones from these runs on this release. - The user guide's "File documents" section and the docs index link to both pages.
arthware-dev
added a commit
that referenced
this pull request
Oct 20, 2026
* fix(core): let the bots read the encrypted rooms they are invited to The bots meant to stay out of encrypted rooms, and in practice could not read them: a restored session never opened the device's key store, so from a bot's first restart on nio ran without encryption at all. Element X encrypts direct chats, so a family on it could not talk to the agent. Inviting a bot is now the family's opt-in to have famstack process that room, encrypted or not. - A restored session loads its key store, as a password login does. - After every sync the bot does the key upkeep nio's `sync_forever` does: tops up one-time keys, queries and claims other devices' keys, sends queued to-device messages. - Sends never wait on verifying a device; on the family's own server every device is a family member's. - A message without its key gets a notice saying so and what to try, instead of "by design". (cherry picked from commit 975008a) * fix(core): open photos, files and voice messages from encrypted rooms An attachment sent in an encrypted room reached no bot: nio parses it as an encrypted media event, which no handler listens for, and the file on the server is ciphertext. The bot runner now hands handlers the plain event, as from an unencrypted room, and decrypts the file on download with the key its event carried. (cherry picked from commit 0c16520) * docs(messages): say that bots read the encrypted rooms they are in The user guide told families to switch encryption off for every room with a bot, because the bots could not read encrypted messages. They now can, and inviting a bot is the opt-in to have famstack read that room. The guide says so, explains the notice a bot sends when a key is missing, and drops the screenshot of the old notice. ADR-004 notes the change to its encryption policy. (cherry picked from commit 01ab026) * chore: bump the version to 0.4.0 The next release is 0.4.0, the first final release since 0.3.0-beta.3. The tag, `lib/stack/cli.py`, `pyproject.toml` and the lock all spell it `0.4.0`. * docs(readme): describe what 0.4.0 adds The README named rc.2 as the current beta. It now names 0.4.0 as the current release and adds what changed for an admin coming from 0.3.0-beta.3: the bots read encrypted chats, and `./stack update` with the menu bar app. The roadmap shows the 0.3 features as live and lists and backups as beta. The release check reads that sentence, so it now accepts "the current release" for a final release as well as "the current Beta". * fix(archivist): detect a deferral in any language to start the deep dive A question whose answer is only in a document's text never got the real answer in a non-English household. The deep dive starts when the first answer defers, and the bot recognised a deferral only by the English phrase "need to read". A German household got the deferral in German, so the archivist posted it as the answer and stopped. The model also answered "no" or "cannot be determined" when a short summary did not mention the detail asked for. - The synthesis prompt asks for a `NEED_TO_READ [N]` line after the deferral sentence, written the same in every language. The bot starts the deep dive on it and removes it before the family sees the answer. The English phrase still counts. - A new prompt rule: a summary that does not mention a detail is a reason to defer, not evidence that the document lacks it. Fixes: e12ade2 ("feat(archivist): natural-language questions get a synthesized answer") * docs(readme): lead with documents and answers Open with what users told us they want: drop a document in the family chat and ask about it later. The supporting points follow in that order: photos, the diary and the wiki, nothing leaving the home, then the Mac. - "New in 0.4" as five short bullets, with a link to the release notes - a quote from an early adopter, and GitHub Discussions as a way to report problems for people who do not use Discord - the memory 16 GB and 32 GB Macs need, in the Quick Start - the roadmap marks the memory bank and encrypted chats as live and names the 0.5 topics: Stacky as the family's assistant and the wiki - the secrets file is `.stack/secrets.toml`, and stacklets carry `hooks/` instead of `setup.sh` * docs(archivist): add a documents page, from photo to answer (#279) - `docs/use/documents.md` tells the whole documents flow for a newcomer: photograph a document, send it to the Documents Room, the archivist's reply, the to-dos and dates it takes from a letter, asking months later, where the documents are stored, and the hardware it needs. `docs/de/use/documents.md` is the German page, written for German households, with a short FAQ (Paperless-ngx, cloud, German documents). - Three screenshots per language from the test rig with the fabricated Simpson family, in Element's dark theme (`docs/assets/documents-*.png`). The replies quoted on the pages are the real ones from these runs on this release. - The user guide's "File documents" section and the docs index link to both pages.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/use/documents.mdtells the whole documents flow for a newcomer: photograph a document, send it to the Documents Room, the archivist's reply, the to-dos and dates it takes from a letter, asking months later, where the documents are stored, and the hardware it needs.docs/de/use/documents.mdis the German page, written for German households, with a short FAQ (Paperless-ngx, cloud, German documents).docs/assets/documents-*.png). The replies quoted on the pages are the real ones from these runs on this release.The same pages for 0.5 are in #268. Squash merge.