Show the interface the pages describe, with pictures generated from a demo instance (#353)
Thirty-four pictures from scripts/screenshots.py in the postulo repository, each with alternative text, placed beside the text that describes it. Never retake one by hand: run the script.
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Writing a plugin names MessagingService, MessagingServicePlugin and messaging_service_of
and says the kind registers in postulo.messaging_services. Refs postulo/postulo#682 #672#665#658#656#333
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Say what a fetch refuses, how long it waits, and what an import does with a username
Addresses that carry a private one are refused; a page, its robots.txt
and a logo are held to a whole-download time as well as a size; only
gzip and deflate are unpacked; an archive's username is taken only when
the rules allow it; and Python 3.12.4 is the oldest Python.
Refs postulo/postulo#321
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Say how a page with no standard is read, and how a site learns from your corrections
Capturing postings says what the fallback reads now (a title line split
only where the page vouches for a part, a salary and a closing date
after the words the page's own language uses) and gains *Sites you
capture from often*: where a correction is remembered, what teaches and
what does not, how a field says it came from a remembered place, how a
place forgets itself and how you forget it. The capture API documents
`hinted` on a preview and that corrections sent with a capture teach
the same way. Writing a plugin says what the fallback source does, that
remembered places go only to Postulo's own sources, and names the two
new names on the surface. Backups says the export carries them.
Refs postulo/postulo#267
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Say how a capture keeps the page it was read from, and what keeps that page harmless
Capturing postings gains *Keeping the page*: the source and a
rendering, both off until an administrator and then the person switch
them on, where the kept page is, how long it stays and the account's
ceiling. Its two sentences that still called the browser extension
planned now point at the one that exists.
The capture API documents `keep` and the `page` member of a capture,
the `PUT` that sends a rendering with its answers, the three problem
types it adds, the `413` a request too large for the API now gets, and
what the extensions send today. Configuration lists the six settings
and why keeping is off by default; Hardening says why a kept page never
runs as the stranger's code; the metrics page counts kept pages.
Refs postulo/postulo#256
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Say that a single key can be switched off, and what focus now does
Accessibility said "focus is always visible", which was not true in a
high-contrast theme: the border and the ring Postulo drew focus with are
exactly what forced colours discards, so every field in the application
had no visible focus for anybody using one. It also did not mention that
three single keys do something, which is the sort of omission that leaves
somebody who dictates to their computer discovering `d` by losing a
listing to it.
So the page now says both, along with the two smaller promises the code
started keeping: that sorting, paging and switching theme leave focus where
you pressed, and that the first heading on a page is the page's own name.
Capturing postings and Getting started say where the switch is. Tracking
applications says that each board menu is named by its own application, and
that a status chosen with the keyboard is saved when the choosing stops
rather than at every status passed on the way -- which is a change in when
the card moves, and worth a sentence where somebody will read it. The
column handle reports its width now, so the line claiming the keyboard
works no longer leaves out that it used to do it silently.
Closes#227
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Document the whole API surface: every call, the machine endpoints, the plugin API
The API named every call, but the scope each needs lived in prose, and
the discard reasons and what /me answers were not written anywhere. It
gains both, and one list of all 39 calls with method, path and scope,
generated from the API's own routers.
/healthz, /metrics and /logs answer machines about the instance and
were only rows in Configuration. Health, metrics and logs says what
each returns, how it is switched on and guarded, the rate limit, the
parameters /logs takes, and every metric with its labels.
The plugin guide was postulo's docs/PLUGINS.md and never reached the
wiki. It is Writing a plugin now, opening with every kind of plugin,
its entry-point group and the interface it satisfies, and carrying a
reference of all 37 names postulo.plugins.api promises -- eight of
which the guide had never named. It also says plainly that a
notifier's Notification, and the client's DestinationRefused, are used
from outside the surface today.
The sidebar gains a Building on it group for the API and the plugin
guide, and the three pages that linked to docs/PLUGINS.md link here.
postulo's tests/test_wiki_surface.py now reads these three pages
against the code.
Refs postulo/postulo#170
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Take the pages over from postulo/wiki, which this repository now replaces
Until now this was a copy of postulo/wiki, refreshed by postulo's
scripts/publish-wiki.sh whenever somebody remembered to run it. The last
time was 5 September (postulo@9645ee1). This brings it to postulo@b6cfb8f7:
- the four pages that never arrived: Accessibility, Hardening, Listings
and Reports;
- the seventeen that had changed since;
- the images, which the script never copied because it copied *.md and
nothing else, so Home has shown its logo and its Buy me a coffee button
broken since the day they were added.
Nothing here was lost: every earlier commit is a publish, and the pages
they left matched postulo/wiki at 9645ee1 exactly.
From here pages are written in this repository and nowhere else.
Refs postulo/postulo#169
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
