Skip to content

docs: add direct editing developer documentation - #15063

Merged
juliusknorr merged 2 commits into
masterfrom
feature/direct-editing-docs
Jun 2, 2026
Merged

docs: add direct editing developer documentation#15063
juliusknorr merged 2 commits into
masterfrom
feature/direct-editing-docs

Conversation

@juliusknorr

@juliusknorr juliusknorr commented Jun 2, 2026

Copy link
Copy Markdown
Member

☑️ Resolves

New developer documentation for the direct editing API — no existing page covered it.

Adds developer_manual/digging_deeper/direct_editing.rst and links it into the
Digging deeper toctree. It documents three layers: editor registration
(IEditor, creators, templates), the OCS HTTP API, and the webview messaging
convention used by the mobile clients. The documentLoaded webview message is
marked deprecated since Nextcloud 34 (replaced by loaded).

🖼️ Screenshots

Built and reviewed locally (make html). Happy to attach rendered screenshots if useful.

✅ Checklist

  • I have built the documentation locally and reviewed the output
  • Screenshots are included for visual changes
  • I have not moved or renamed pages (or added a redirect if I did)
  • I have run codespell or similar and addressed any spelling issues
Screenshot image

Document the direct editing API: editor registration (IEditor, creators,
templates), the OCS HTTP API, and the webview messaging convention used by
the mobile clients.

AI-assistant: Claude Code 2.1.160 (claude-opus-4-8)
Signed-off-by: Julius Knorr <jus@bitgrid.net>
richdocuments now uses the generic DirectEditingMobileInterface; update the
interface object description and code examples accordingly.

AI-assistant: Claude Code 2.1.160 (claude-opus-4-8)
Signed-off-by: Julius Knorr <jus@bitgrid.net>

@moodyjmz moodyjmz left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Looks good to me

@github-actions

github-actions Bot commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

📖 Documentation Preview

🔍 Open preview →

📄 2 changed documentation pages

Last updated: Tue, 02 Jun 2026 11:29:37 GMT

@juliusknorr
juliusknorr merged commit 546fa26 into master Jun 2, 2026
27 checks passed
@juliusknorr
juliusknorr deleted the feature/direct-editing-docs branch June 2, 2026 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants