LibreKAT/Ocideck
LibreKAT/Ocideck
Watch
4
0
Fork
You've already forked Ocideck
 0
Code Issues 3 Pull requests 1 Projects Releases 4 Packages Activity Actions 1

[Docs] There is not a single screenshot of a tool whose entire purpose is visual #585

New issue
Closed
opened 2026-07-22 16:16:35 +00:00 by brenno · 4 comments
brenno commented 2026-07-22 16:16:35 +00:00
Owner
Copy link

Found independently by three reviewers in the pre-publication review.

Evidence: grep -c "!\[" README.md → 0. find docs assets/images -name "*.png" -o -name "*.jpg" → ten logos, three cats, zero screenshots. The one image in docs/USER_GUIDE.md:511 is an example of Marp syntax, not of the product. The feature section of the README is roughly 1,990 words with no visual evidence at all.

Why this must be fixed before publication: this is a tool for showing things. The first question any visitor has is what it looks like. Right now the front page reads as 24 bold promises from a single author with not one exhibit — precisely the shape in which "too much, too early, nothing is finished" writes itself. It is also the cheapest fix in the entire review, and it falls between the cracks: #520 covers producing a release, and this belongs to nothing.

Proposal: four PNGs in docs/images/, one of them directly under the opening paragraph of the README:

  1. the editor with the slide strip, an editor panel and the live preview
  2. the quality panel showing an OciWacht finding (with the value hidden, as the app does)
  3. the export dialog with the full/redacted choice
  4. the presenter view

Keep each under ~300 KB so the clone stays cheap. No GIF, no video, no website needed.

Found independently by three reviewers in the pre-publication review. **Evidence:** `grep -c "!\[" README.md` → **0**. `find docs assets/images -name "*.png" -o -name "*.jpg"` → ten logos, three cats, zero screenshots. The one image in `docs/USER_GUIDE.md:511` is an example of Marp syntax, not of the product. The feature section of the README is roughly 1,990 words with no visual evidence at all. **Why this must be fixed before publication:** this is a tool for showing things. The first question any visitor has is what it looks like. Right now the front page reads as 24 bold promises from a single author with not one exhibit — precisely the shape in which "too much, too early, nothing is finished" writes itself. It is also the cheapest fix in the entire review, and it falls between the cracks: #520 covers producing a release, and this belongs to nothing. **Proposal:** four PNGs in `docs/images/`, one of them directly under the opening paragraph of the README: 1. the editor with the slide strip, an editor panel and the live preview 2. the quality panel showing an OciWacht finding (with the value hidden, as the app does) 3. the export dialog with the full/redacted choice 4. the presenter view Keep each under ~300 KB so the clone stays cheap. No GIF, no video, no website needed.
brenno commented 2026-07-22 17:30:29 +00:00
Author
Owner
Copy link

Niet meegenomen in #656 (de docs-reparatieronde): dit vraagt iets anders dan tekst — respectievelijk vier schermafdrukken van de draaiende app, en een herbouw plus herdeploy van de webdemo. Blijft open.

Niet meegenomen in #656 (de docs-reparatieronde): dit vraagt iets anders dan tekst — respectievelijk vier schermafdrukken van de draaiende app, en een herbouw plus herdeploy van de webdemo. Blijft open.
brenno commented 2026-07-22 17:36:12 +00:00
Author
Owner
Copy link

Stand na #656 (gemerged), geverifieerd op main: onveranderd open. grep -c "!\[" README.md geeft nog steeds 0.

De README is in die ronde wel flink ingekort (#590), dus de plek waar een schermafdruk het meeste doet — direct onder de openingsalinea — is nu vrijer dan hij was.

Ik had dit issue op in-progress gezet omdat het in de tros van #656 werd genoemd; die is gemerged zonder dat dit erin zat. Claim eraf, zodat een volgende sessie hem gewoon kan oppakken.

Stand na `#656` (gemerged), geverifieerd op `main`: **onveranderd open**. `grep -c "!\[" README.md` geeft nog steeds **0**. De README is in die ronde wel flink ingekort (#590), dus de plek waar een schermafdruk het meeste doet — direct onder de openingsalinea — is nu vrijer dan hij was. Ik had dit issue op `in-progress` gezet omdat het in de tros van #656 werd genoemd; die is gemerged zonder dat dit erin zat. Claim eraf, zodat een volgende sessie hem gewoon kan oppakken.
brenno commented 2026-07-22 22:00:42 +00:00
Author
Owner
Copy link

Opgepakt. Tak: docs/schermafdrukken-585. Reikwijdte: docs/images/ met de vier schermafdrukken uit je voorstel, plus de README en waar het in de gebruikershandleiding helpt.

Opgepakt. Tak: `docs/schermafdrukken-585`. Reikwijdte: `docs/images/` met de vier schermafdrukken uit je voorstel, plus de README en waar het in de gebruikershandleiding helpt.
brenno commented 2026-07-22 22:39:04 +00:00
Author
Owner
Copy link

Opgelost in PR #703, op main.

Vier PNG's in docs/images/, elk onder de 300 KB: de editor direct onder de openingsalinea, en de privacyscan, het exportdialoog en de presentatorweergave eronder. Alle vier op een verzonnen pentestrapport-deck — geen echte namen, adressen of nummers, met voorbeeld.example als scope.

De privacyschermafdruk laat expliciet zien wat het product belooft: de gevonden waarde staat afgekapt ("IP-adres (1…0)", "telefoonnummer (+…8)"), nooit voluit, precies zoals de app het overal behandelt. Ik heb ze alle vier zelf bekeken voordat ze erin gingen — dat is de reden dat dit geen tekstwerk was.

Wat er niet in zit: de link naar de live webdemo. Die hoort bij #589 (herbouw + herdeploy), dat een deploy vraagt die ik niet kan doen.

Opgelost in PR #703, op main. Vier PNG's in `docs/images/`, elk onder de 300 KB: de editor direct onder de openingsalinea, en de privacyscan, het exportdialoog en de presentatorweergave eronder. Alle vier op een verzonnen pentestrapport-deck — geen echte namen, adressen of nummers, met `voorbeeld.example` als scope. De privacyschermafdruk laat expliciet zien wat het product belooft: de gevonden waarde staat afgekapt ("IP-adres (1…0)", "telefoonnummer (+…8)"), nooit voluit, precies zoals de app het overal behandelt. Ik heb ze alle vier zelf bekeken voordat ze erin gingen — dat is de reden dat dit geen tekstwerk was. **Wat er niet in zit:** de link naar de live webdemo. Die hoort bij #589 (herbouw + herdeploy), dat een deploy vraagt die ik niet kan doen.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
ci/per-pr-static-gate-1118
codex/markdown-editor-translations
codex/markdown-editor-ux
codex/template-followup
cockpit-wip
v0.1.3
v0.1.2
v0.1.1
v0.1.0
archive/git-mirror
Labels
Clear labels   
accepted
Assessed and will be built

  
bug
Something is broken

  
declined
Assessed and will not be built

  
docs
Documentation only

  
duplicate
Already tracked elsewhere

  
enhancement
New feature or improvement request

  
good first issue
Small, self-contained, and a good place to start

  
in-progress
Someone is working on this right now. Do not start it in parallel.

  
needs-info
Waiting for the reporter

  
privacy
Personal data can leak. Handled before anything else.

  
security
A weakness someone could use. Handled before anything else.

  
triage
Awaiting assessment

No labels
accepted
bug
declined
docs
duplicate
enhancement
good first issue
in-progress
needs-info
privacy
security
triage
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
LibreKAT/Ocideck#585
No description provided.