Development
Thomas Forgione edited this page 2026-09-11 16:45:02 +02:00

Page revisions

13 Commits

Author SHA1 Message Date
e32890ccfa
Say what grep does, what it costs and where it stops 2026-09-11 16:45:02 +02:00
6ed00dad34
Say what edit_file does and why it refuses what it refuses 2026-09-11 14:57:13 +02:00
97b02ac1af
Say there is no round limit, and document write_file
max_rounds is configurable and signed, negative meaning no ceiling, which is
the default. Ctrl-C is what stops a turn instead. And the third disk tool
writes.
2026-09-11 11:41:30 +02:00
996f3f513f
Describe the tools papote has, and being asked about them
Three tools now rather than one, two of which read the disk and therefore
stop and ask. Says what the prompt looks like, what each key does, that Esc
is an answer, and how to set the permissions up in advance under [tools].
2026-09-11 11:25:19 +02:00
cb00a31216
Describe wire.rs, and what an unknown word on the bar means
The protocol is Rust types now, not JSON values, so the file table gains
wire.rs. Worth saying too that a word papote has no variant for shows on the
bar and is a bug in papote rather than something wrong with your endpoint.
2026-09-11 10:45:07 +02:00
59ed99229b
Describe the three groups the modules now sit in
The file table follows the tree: app/, chat/, render/, and the four files
that belong to no group because everything leans on them.
2026-09-11 10:08:52 +02:00
14adbb1de0
The screen has its own file now
`app.rs` became `app/mod.rs` and `app/draw.rs`; the file table says which
does what.
2026-09-11 09:59:01 +02:00
c39d32f348
Document tool calling
A Tools section on the usage page: what a tool is for, what the two muted
lines in the conversation are, the one tool there is, the five-round guard,
and the `tools` key with the `--jinja` caveat that makes it worth having.
The configuration page gains the key, and the dependency page the two crates
behind the clock.
2026-09-11 09:38:15 +02:00
e47d6d1e4a
Document pasting an image
A "Pasting one" section: why a file copied in a file manager can be pasted
straight in while a screenshot needs Ctrl-V, what Ctrl-V does with text, and
that a screenshot goes as a flattened JPEG. The keys table gains Ctrl-V, and
the dependency page explains what arboard costs and why its Wayland feature
is the decision rather than the crate.
2026-09-10 21:56:31 +02:00
086b23d77d
Note that a WebP is converted before it is sent
The Images section says why a `.webp` shows as `image/jpeg`: the server
decodes with stb_image, which cannot read WebP at all, so papote converts it
in memory and flattens any transparency onto white. The dependency page
explains what `image` is there for, what it costs, and what was weighed
against it.
2026-09-10 21:41:09 +02:00
150829c36d
Note the library layout and the documentation warning
The crate is a library with a one-line binary on top, so `cargo doc --open`
now gives the whole thing and `#![warn(missing_docs)]` keeps it complete.
The file table gains `lib.rs`, and the claim that tests cannot live in
`tests/` because the crate is a binary is no longer true.
2026-09-10 19:27:07 +02:00
eb67105f75
Document the live counters and what the pty harness is for 2026-09-10 17:49:04 +02:00
21a9383bdf
Split the README's detail across nine pages, with a sidebar
The README had grown to 279 lines and buried the point under a full
configuration reference. It keeps the pitch, the example and a quick start;
everything else moves here, one page per thing you might actually be looking
for.

_Sidebar.md gives every page the same three-section column: getting started,
using it, under the hood.
2026-09-10 17:09:02 +02:00