Overhaul web extension system docs by JammingBen · Pull Request #1187 · opencloud-eu/docs

JammingBen · 2026-09-22T08:57:05Z

Give the web extension system docs a much needed update and overhaul.

Add missing extensions and extension points
Update code examples and interfaces
Give the docs a new structure and add new content:

Extension System/
├── Getting started
├── Build and publish
├── Advances topics/
│   ├── Configuration
│   ├── Styling
│   ├── Translations
│   └── Testing
├── Extensions/                     
│   ├── Extension Points
│   └── Extension Types/
│       └──  ...
├── Viewer and editor apps/
│   └──Collaborative Editing
└── Helpful packages

I applied this structure and its relevant parts to the 7.2 docs as well, as they are still the default. The 4.2 docs I did not touch though.

closes #999
closes opencloud-eu/web#3112

Copilot

Copilot review overview

🟡 Changes recommended

Multiple moderate issues remain, including broken copy-paste examples and missing redirects.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 13 · 4

Open (17)

Fix incorrect App.vue import path · New
Define $ngettext before using it · New
Use a custom-component extension point · New
Add missing gettext setup and type import · New
Define $gettext in the app entrypoint · New
Return refs for extensions and extension points · New
Import toRef in App.vue · New
Fix incorrect App.vue import path · New
Define $ngettext before using it · New
Use a custom-component extension point · New
Add missing gettext setup and type import · New
Define $gettext in the app entrypoint · New
Return refs for extensions and extension points · New
Remove duplicated “are” · New
Restore documentation for options settings · New
Remove duplicated “are” · New
Restore documentation for options settings · New

What changed in this PR

This pull request overhauls the Web extension-system documentation for the current and 7.2 releases.

Changes:

Reorganizes extension documentation and adds setup, publishing, and advanced-topic guides.
Expands extension types, extension points, package references, and app-development examples.
Adds collaborative editing, vault, and resource-indicator documentation.

File	Description
`versioned_docs/version-7.2/dev/web/getting-started.md`	Updates Web configuration guidance.
`versioned_docs/version-7.2/dev/web/extension-system/viewer-editor-apps/index.md`	Updates viewer/editor examples and interfaces.
`versioned_docs/version-7.2/dev/web/extension-system/viewer-editor-apps/_category_.json`	Adds sidebar category metadata.
`versioned_docs/version-7.2/dev/web/extension-system/packages.md`	Adds helpful package references.
`versioned_docs/version-7.2/dev/web/extension-system/index.md`	Updates the extension-system overview.
`versioned_docs/version-7.2/dev/web/extension-system/getting-started.md`	Adds app setup and development guidance.
`versioned_docs/version-7.2/dev/web/extension-system/extensions/index.md`	Documents extension registration and querying.
`versioned_docs/version-7.2/dev/web/extension-system/extensions/extension-types/search-extensions.md`	Updates search extension examples.
`versioned_docs/version-7.2/dev/web/extension-system/extensions/extension-types/right-sidebar-panel-extensions.md`	Updates sidebar panel examples.
`versioned_docs/version-7.2/dev/web/extension-system/extensions/extension-types/left-sidebar-menu-item-extensions.md`	Adds sidebar navigation documentation.
`versioned_docs/version-7.2/dev/web/extension-system/extensions/extension-types/index.md`	Adds the extension-type catalog.
`versioned_docs/version-7.2/dev/web/extension-system/extensions/extension-types/folder-view-extensions.md`	Updates folder-view API documentation.
`versioned_docs/version-7.2/dev/web/extension-system/extensions/extension-types/floating-action-button-extensions.md`	Updates floating-action-button APIs.
`versioned_docs/version-7.2/dev/web/extension-system/extensions/extension-types/custom-component-extensions.md`	Documents component props.
`versioned_docs/version-7.2/dev/web/extension-system/extensions/extension-types/app-menu-item-extensions.md`	Updates menu-item handlers and examples.
`versioned_docs/version-7.2/dev/web/extension-system/extensions/extension-types/action-extensions.md`	Updates action examples and links.
`versioned_docs/version-7.2/dev/web/extension-system/extensions/extension-types/account-extensions.md`	Adds account extension documentation.
`versioned_docs/version-7.2/dev/web/extension-system/extensions/extension-types/_category_.json`	Adds extension-type navigation metadata.
`versioned_docs/version-7.2/dev/web/extension-system/extensions/extension-points.md`	Documents extension points and authoring guidance.
`versioned_docs/version-7.2/dev/web/extension-system/extensions/_category_.json`	Adds extensions category metadata.
`versioned_docs/version-7.2/dev/web/extension-system/extension-types/left-sidebar-menu-item-extensions.md`	Removes the old sidebar page location.
`versioned_docs/version-7.2/dev/web/extension-system/extension-types/index.md`	Removes the old extension-type index.
`versioned_docs/version-7.2/dev/web/extension-system/build-and-publish.md`	Adds build and publishing guidance.
`versioned_docs/version-7.2/dev/web/extension-system/advanced-topics/translations.md`	Adds translation workflow guidance.
`versioned_docs/version-7.2/dev/web/extension-system/advanced-topics/testing.md`	Adds testing guidance.
`versioned_docs/version-7.2/dev/web/extension-system/advanced-topics/styling.md`	Adds styling and design-system guidance.
`versioned_docs/version-7.2/dev/web/extension-system/advanced-topics/configuration.md`	Adds app configuration guidance.
`versioned_docs/version-7.2/dev/web/extension-system/advanced-topics/_category_.json`	Adds advanced-topics metadata.
`docs/dev/web/getting-started.md`	Updates Web configuration guidance.
`docs/dev/web/extension-system/viewer-editor-apps/index.md`	Updates viewer/editor examples.
`docs/dev/web/extension-system/viewer-editor-apps/collaborative-editing.md`	Adds collaborative-editing guidance.
`docs/dev/web/extension-system/viewer-editor-apps/_category_.json`	Adds sidebar category metadata.
`docs/dev/web/extension-system/packages.md`	Adds helpful package references.
`docs/dev/web/extension-system/index.md`	Updates the extension-system overview.
`docs/dev/web/extension-system/getting-started.md`	Adds app setup and development guidance.
`docs/dev/web/extension-system/extensions/index.md`	Documents extension registration and querying.
`docs/dev/web/extension-system/extensions/extension-types/vault-extensions.md`	Adds vault extension documentation.
`docs/dev/web/extension-system/extensions/extension-types/search-extensions.md`	Updates search extension examples.
`docs/dev/web/extension-system/extensions/extension-types/right-sidebar-panel-extensions.md`	Updates sidebar panel examples.
`docs/dev/web/extension-system/extensions/extension-types/resource-indicator-extensions.md`	Adds resource indicator documentation.
`docs/dev/web/extension-system/extensions/extension-types/left-sidebar-menu-item-extensions.md`	Adds sidebar navigation documentation.
`docs/dev/web/extension-system/extensions/extension-types/index.md`	Adds the extension-type catalog.
`docs/dev/web/extension-system/extensions/extension-types/folder-view-extensions.md`	Updates folder-view API documentation.
`docs/dev/web/extension-system/extensions/extension-types/floating-action-button-extensions.md`	Updates floating-action-button APIs.
`docs/dev/web/extension-system/extensions/extension-types/custom-component-extensions.md`	Documents component props.
`docs/dev/web/extension-system/extensions/extension-types/app-menu-item-extensions.md`	Updates menu-item handlers and examples.
`docs/dev/web/extension-system/extensions/extension-types/action-extensions.md`	Updates action examples and links.
`docs/dev/web/extension-system/extensions/extension-types/account-extensions.md`	Adds account extension documentation.
`docs/dev/web/extension-system/extensions/extension-types/_category_.json`	Adds extension-type navigation metadata.
`docs/dev/web/extension-system/extensions/extension-points.md`	Documents extension points and authoring guidance.
`docs/dev/web/extension-system/extensions/_category_.json`	Adds extensions category metadata.
`docs/dev/web/extension-system/extension-types/left-sidebar-menu-item-extensions.md`	Removes the old sidebar page location.
`docs/dev/web/extension-system/extension-types/index.md`	Removes the old extension-type index.
`docs/dev/web/extension-system/build-and-publish.md`	Adds build and publishing guidance.
`docs/dev/web/extension-system/advanced-topics/translations.md`	Adds translation workflow guidance.
`docs/dev/web/extension-system/advanced-topics/testing.md`	Adds testing guidance.
`docs/dev/web/extension-system/advanced-topics/styling.md`	Adds styling and design-system guidance.
`docs/dev/web/extension-system/advanced-topics/configuration.md`	Adds app configuration guidance.
`docs/dev/web/extension-system/advanced-topics/_category_.json`	Adds advanced-topics metadata.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

JammingBen · 2026-09-22T12:31:47Z


 Specifies the URL for the theme to be loaded, e.g. `https://host.docker.internal:9200/themes/opencloud/theme.json`.

-### `options`


I decided to remove this while I was at it. It's not how we recommend setting these, and it's all documented already via the env vars in the respective services.

kulmann

Nice lift!
Some comments. And what I also noticed: Code examples use a lot of semicolons, which is against the usual code style of OpenCloud Web. Do you want to adjust that?

JammingBen · 2026-09-30T14:46:57Z

And what I also noticed: Code examples use a lot of semicolons, which is against the usual code style of OpenCloud Web. Do you want to adjust that?

Yes, but in a separate PR because we need a special rule for the formatter. Otherwise, it would format the generated service docs without semicolons as well. I'll do it as a follow-up.

JammingBen self-assigned this Sep 22, 2026

JammingBen added the Docs:Developer label Sep 22, 2026

JammingBen force-pushed the docs/extension-system-overhaul branch from bf43168 to 11e7bc0 Compare September 22, 2026 09:30

JammingBen mentioned this pull request Sep 22, 2026

chore: remove unnecessary stuff opencloud-eu/web-app-skeleton#133

Open

JammingBen force-pushed the docs/extension-system-overhaul branch 2 times, most recently from f7c1e30 to 112ee1d Compare September 22, 2026 11:59

JammingBen marked this pull request as ready for review September 22, 2026 11:59

Copilot AI lite review requested due to automatic review settings September 22, 2026 11:59

Copilot started reviewing on behalf of JammingBen September 22, 2026 11:59 View session

Copilot AI reviewed Sep 22, 2026

View reviewed changes

JammingBen force-pushed the docs/extension-system-overhaul branch from 112ee1d to af0ff04 Compare September 22, 2026 12:21

JammingBen requested a review from kulmann September 22, 2026 12:21

JammingBen commented Sep 22, 2026

View reviewed changes

JammingBen and others added 2 commits September 22, 2026 16:06

docs(dev): overhaul web extension system docs

9f36be4

docs(dev): add web section index pages

2036e50

JammingBen force-pushed the docs/extension-system-overhaul branch from f2f5926 to 2036e50 Compare September 22, 2026 14:06

kulmann reviewed Sep 30, 2026

View reviewed changes

docs(dev): apply suggestions from review

31ac16b

JammingBen requested a review from kulmann September 30, 2026 14:47

kulmann approved these changes Oct 1, 2026

View reviewed changes

kulmann merged commit 9181c1b into main Oct 1, 2026
2 checks passed

kulmann deleted the docs/extension-system-overhaul branch October 1, 2026 11:46

openclouders mentioned this pull request Sep 30, 2026

🎉 Release 3.49.0 #1189

Open

1 task

Navigation Menu

Overhaul web extension system docs - #1187

Overhaul web extension system docs#1187
kulmann merged 3 commits into
mainfrom
docs/extension-system-overhaul

JammingBen commented Sep 22, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JammingBen Sep 22, 2026

Uh oh!

kulmann left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JammingBen commented Sep 30, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants


		Specifies the URL for the theme to be loaded, e.g. `https://host.docker.internal:9200/themes/opencloud/theme.json`.

		### `options`

Conversation

JammingBen commented Sep 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JammingBen Sep 22, 2026

Choose a reason for hiding this comment

Uh oh!

kulmann left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JammingBen commented Sep 30, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

JammingBen commented Sep 22, 2026 •

edited

Loading