Skip to content

docs: add screenshots to README#149

Merged
JohnMcLear merged 1 commit into
mainfrom
docs/readme-screenshots
Jun 19, 2026
Merged

docs: add screenshots to README#149
JohnMcLear merged 1 commit into
mainfrom
docs/readme-screenshots

Conversation

@JohnMcLear

@JohnMcLear JohnMcLear commented Jun 17, 2026

Copy link
Copy Markdown
Member

Adds a Screenshots section to the README so the project page shows what the integration actually does at a glance.

Three screenshots, captured against Nextcloud 30 + a live Etherpad with this app installed:

  1. + New menu - the pad-creation entries the app adds (New pad / Public pad / Public pad from URL).
  2. Embedded editor - a .pad opened in the native Nextcloud viewer, with two authors editing in real time (per-author colours, live presence count).
  3. .pad in Files - a pad sitting alongside ordinary files in the Files app.

Images live in docs/screenshots/ and are sized for README rendering (1100px wide, ~45-180KB each).

🤖 Generated with Claude Code

@JohnMcLear @claude
docs: add screenshots to README
2380b1c 
Add a Screenshots section showing the three core touchpoints: creating a
pad from the Files '+ New' menu, the linked Etherpad pad open in the native
Nextcloud viewer with real-time multi-author collaboration, and a .pad file
sitting in the Files app. Captured against Nextcloud 30 + Etherpad with the
app installed.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@qodo-code-review

qodo-code-review Bot commented Jun 17, 2026

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@qodo-free-for-open-source-projects

qodo-free-for-open-source-projects Bot commented Jun 17, 2026

Copy link
Copy Markdown

PR Summary by Qodo

Docs: add screenshots section to README
📝 Documentation 🕐 Less than 5 minutes

Grey Divider

Description 

• Add a README “Screenshots” section to show key integration touchpoints at a glance
• Embed three images demonstrating pad creation, in-viewer editing, and .pad files in Files
High-Level Assessment

The approach is appropriate for a docs-only PR: a dedicated “Screenshots” section with short captions and inline images is the clearest way to communicate the integration visually. Considered alternatives (external links, collapsible sections) would reduce immediacy or add friction on the project page.

Files changed (1) +14 / -0

Documentation (1) +14 / -0
README.mdAdd “Screenshots” section with three illustrative images +14/-0

Add “Screenshots” section with three illustrative images

• Introduces a new “Screenshots” section before Requirements, with short captions and three embedded images. The images highlight pad creation from the Files “+ New” menu, real-time collaborative editing in the native viewer, and '.pad' files appearing in the Files list.

README.md

@qodo-free-for-open-source-projects

qodo-free-for-open-source-projects Bot commented Jun 17, 2026

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Qodo Logo

@JohnMcLear

JohnMcLear commented Jun 18, 2026

Copy link
Copy Markdown
Member Author

cc @Jaggob - I'll work on a gif/mp4 too for etherpad-megaphone

@JohnMcLear JohnMcLear merged commit d6313d8 into main Jun 19, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Jaggob Jaggob Jaggob approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@JohnMcLear @Jaggob