Skip to content

Update docs for Inbox release#383

Open
ChumOfChance wants to merge 15 commits intomainfrom
inbox-release
Open

Update docs for Inbox release#383
ChumOfChance wants to merge 15 commits intomainfrom
inbox-release

Conversation

@ChumOfChance
Copy link
Copy Markdown
Contributor

@ChumOfChance ChumOfChance commented Apr 6, 2026

This updates the Workstation documentation to account for the release of the new SecureDrop Inbox.

  • Changes SecureDrop App to SecureDrop Inbox
  • Moves instructions for accessing the legacy client to the Journalist guide
  • Updates screenshots (if needed)
  • Updates usage instructions (if needed)

Test plan

Checklist

This change accounts for:

  • local preview of changes beyond typo-level edits

@ChumOfChance ChumOfChance moved this to In Progress in SecureDrop Apr 6, 2026
@ChumOfChance ChumOfChance self-assigned this Apr 7, 2026
@ChumOfChance
Copy link
Copy Markdown
Contributor Author

@nathandyer seeking your input on cropping all the screenshots to the application window instead of showing the entire desktop, so we get more detail on what's relevant.

I'd like to crop the screenshot_delete_sources_dialog.png further, so that the selected conversation and delete trashcan icon is very obvious in the screenshot.

What do you think?

@nathandyer
Copy link
Copy Markdown
Contributor

@ChumOfChance Definitely a fan of the idea of cropping and focusing solely on the Inbox itself rather than the whole desktop. The only time I hesitate is when the Inbox spawns another window, like opening content in a DispVM. But even then, as long as the viewer is in front of the Inbox window, that's probably fine too.

Another thought experiment is: is there a benefit to having the yellow window chrome surrounding the Inbox in the screenshots? Because if not, we could avoid cropping entirely (whether now or just in future screenshot updates) by running the Inbox in a dev environment and taking screenshots of the window specifically.

We don't have to decide that for this round of updates, though.

And +1 to cropping the delete_sources screenshot further to make the trash can more obvious.

@ChumOfChance
Copy link
Copy Markdown
Contributor Author

I think the yellow border s helpful. It helps orients the user in the Qubes environment, and when other windows are present, the different coloured borders are visible. And yes agreed for dispVM, basically I mean to crop to the "relevant content" which in most of these is just the application window itself.

I am going to run through them and crop before review, I just wanted to check before cropping someone else's screenshots!

@ChumOfChance
Copy link
Copy Markdown
Contributor Author

ChumOfChance commented Apr 21, 2026

Some things I would like to add:

  • describe sync behaviour and Sync Now option
  • describe the menu and how to access it
  • screenshot showing how to sign in when in offline mode
  • explain the "Toggle sort order" option
  • explain the sorting options

@ChumOfChance ChumOfChance requested a review from nathandyer April 23, 2026 18:11
@ChumOfChance ChumOfChance marked this pull request as ready for review April 23, 2026 18:11
@ChumOfChance ChumOfChance moved this from In Progress to Ready For Review in SecureDrop Apr 23, 2026
Copy link
Copy Markdown
Contributor

@nathandyer nathandyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is excellent, @ChumOfChance! The documentation on the new features is especially :chefs-kiss:

One small issue, and a few tiny nits/questions, but this is otherwise really to ship.

Comment thread docs/general/status.rst Outdated
Comment thread docs/journalist/sources.rst Outdated
Deleting
---------

Deleting conversations
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is me asking a pedantic question, and the answer may very well be 'no': To me, "Deleting conversations" implies multiple conversations, but then we have a section below called "Deleting multiple conversations."

Should this be "Deleting a conversation"?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Originally this header was also "Deleting conversations" and I didn't like having the same header in a row. But I think there's a good fix for this.

Comment thread docs/journalist/sources.rst
Comment thread docs/journalist/sources.rst
Co-authored-by: Nathan Dyer <nathandyer@fastmail.com>
@ChumOfChance
Copy link
Copy Markdown
Contributor Author

@nathandyer I went over things with a close eye and tried to fix many consistency issues to address your comments. I also caught a few other things, so this probably warrants a full review (sorry).

nathandyer
nathandyer previously approved these changes Apr 24, 2026
Copy link
Copy Markdown
Contributor

@nathandyer nathandyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just did another full review, and all the changes look great. I'm afraid I have no nits to pick or suggestions to add :)

Going to mark and approval, but leave this up for a bit in case anyone else wants to take a pass before it gets merged.


To display a conversation in the conversation view, simply click a source in the
source list.
To display the conversation with a source in the conversation view, simply click a source in the source list.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, I'm a big fan of this change

Comment thread docs/journalist/sources.rst
SecureDrop administrator, as well as the two-factor code using the method you
have set up. If you have used SecureDrop before, these
are the same credentials that you would use to log in to the Journalist
are the same credentials that you would use to sign in to the Journalist
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another nice consistency catch!

@legoktm
Copy link
Copy Markdown
Member

legoktm commented Apr 24, 2026

I reviewed the docs as whole instead of the diff itself, so some of this may not be directly related to the changes in this PR; I will leave it up to the two of you as to what can be deferred or not.

  • general/introduction
    • should mention Inbox somewhere. Maybe also the main landing page?
  • journalist/starting_client (should be renamed!)
    • "you can double-click on the SecureDrop Inbox desktop shortcut to launch it." because the screenshot is now much smaller, I'd add "in the top left"
    • preflight updater screenshot still says "SecureDrop Client"
    • "...which lets you initiate a sync with your SecureDrop server, get help, sign out, or quit SecureDrop Inbox." - Let's only mention the manual sync initiation after explaining that it's mostly automatic. Not sure about "get help"; maybe "view help information"?
    • "will automatically sync with your SecureDrop Instance every time you send a reply, or every 60 seconds" - I think let's swap the order, since the 60s part is more important"
    • or by typing “Ctrl+S”. - not sure if we're consistently using <kbd> but I'd expect this to be marked up somehow instead of quoted
    • Under offline mode, can we re-screenshot the JI menu since the Ctrl+Shift+I shortcut was removed? (or if you can edit it out, whatever is easier)
    • For the legacy Client part, let's add a sentence reminding that it will be removed at the end of May 2026, and that if you have a reason to use it, notify your admins/us. Also there's a sentence in the release blog post about how the two databases are separate that's worth including here.
  • journalist/sources
    • "SecureDrop Workstation lets journalists check SecureDrop, decrypt" - s/Workstation/Inbox/?
    • The sd-gpg permission dialog prompt note can be removed, that fix is finally going out in this release
    • "If a reply fails to be sent successfully," idk if this is still useful, it's phrased a bit weirdly. I think explaining the pending icon vs checkmark might be more useful here.
    • "This will not search for text inside submitted attachments." maybe... "If a file has already been downloaded, the search will cover the filename, but will not include the file contents" or something like that.
    • "the filename will be visible, as will the action Export and Print" weird grammar, maybe "the filename and decrypted size will be shown, as well as a menu to Export and Print the file". But also it feels a bit weird to mention export/print here and not view - maybe we mention view here, or leave the menu/export/print explanation for later.
    • "Click “Print” button and wait for sd-devices VM to start." - should be sd-printers now.
    • "You will prompted to attach your printer" I would use "plug in" to distinguish the physical action vs "attach" (e.g. using the sd-usb menu to attach to a VM)
    • Would be nice if we had a screenshot of the print dialog
    • print guidance should also explain how to print a transcript
    • export guidance should also explain you can export the whole source and not just individual files
  • journalist/faq
    • "Why does it take so long for SecureDrop Inbox to start" but the answer only references SDW. Maybe "Why do I need to wait for so long before I can start processing submissions?" or something

@nathandyer
Copy link
Copy Markdown
Contributor

Thanks @legoktm, I'll go ahead and grab the new/missing screenshots.

@ChumOfChance I feel like most of these items (except perhaps the mention on the main page?) are relatively quick to add or change. Think we can fit them all in before the release?

@ChumOfChance
Copy link
Copy Markdown
Contributor Author

Yeah, I can fit all this in in Monday (or defer a few, I didn't want to get into changing file names since that makes the review more difficult). If @nathandyer you want to handle grabbing all the screenshots that would definitely help!

@nathandyer
Copy link
Copy Markdown
Contributor

No problem at all, I've added a commit with those. If you'd like to see any changes, @ChumOfChance, just say the word.

@nathandyer nathandyer moved this from Ready For Review to Under Review in SecureDrop Apr 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Under Review

Development

Successfully merging this pull request may close these issues.

3 participants