Blacksite/docs/editor/evaluations/README.md

27 lines
1.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Editor Evaluation Evidence
Each subdirectory keeps dated acceptance evidence for an editor feature. Evidence records describe
what was observed against a named implementation; they are not current product specifications.
Resolve current behavior through [`docs/authority.toml`](../../authority.toml) and the linked
canonical guide or ADR. Record visual evidence with its attachment ID, dimensions, and checksum. A
repository image copy is optional; the committed Markdown record, not a raw image URL, is the
durable evidence source.
## Publishing To Gitea
Do not embed a repository `/raw/branch/...` or `/raw/commit/...` PNG URL in an issue or pull-request
comment. Gitea can serve the LFS pointer document at that URL, which renders as text instead of an
image. Upload the PNG to the relevant issue as a native attachment and use the returned
`/attachments/<uuid>` URL for the Markdown image. Keep the committed evaluation link next to the
attachment so the evidence remains traceable to its tested source and exact commit.
Native attachments are the presentation copies used by issues and pull requests. Do not commit a
duplicate image solely to publish it; retain verification notes and attachment metadata in the
evaluation record.
## Records
The [editor documentation index](../README.md) lists feature evidence records. The
[production-readiness matrix](production-readiness/) is the active candidate-evidence ledger;
H1H6 sign-offs are historical snapshots.