docs: streamline release v2 documentation (#6760)

This commit is contained in:
Thomas authored and GitHub committed 2026-09-03 17:03:10 +02:00
1 parent ac62e5bfd6
commit b3aa6155cc
163 files changed
+2908 -4208

No files matched your search

+20 -25
View File
@@ -7,45 +7,40 @@ tags:
- Custom CSS
---
import { WorkshopFlowDiagram } from "@site/src/components/pages/core-concepts/technical-diagrams";
# Community Workshop
The [Community Workshop](pathname:///workshop) is where Homarr users share Custom Widgets and dashboard CSS.
The [Community Workshop](pathname:///workshop) hosts community Custom Widgets and dashboard CSS.
:::warning Experimental
Workshop content is made by the community. Review it before installation and back up your Homarr instance.
Workshop content is community-maintained. Review its source and permissions before installation.
:::
## Find and install content
## Content flow
Browse the Workshop by type, date, popularity, or recent activity. Each submission includes its source, screenshots,
author, revision, comments, and reports.
<WorkshopFlowDiagram />
Administrators can install content without leaving Homarr:
Workshop also exposes the [Homarr Assistant provider](./homarr-provider). Its model-routing and quota path is separate
from Custom Widget and CSS submissions.
- **Custom Widgets:** open **Management → Custom Widgets**, then select **Import from Workshop**.
- **Custom CSS:** open a board's **Settings → Custom CSS**, then select **Import from Workshop**.
## Install content
Homarr shows the complete source and required permissions before installation. Widget credentials are entered in your
Homarr instance and are never included in a Workshop submission.
- Install a Custom Widget from **Management → Custom Widgets → Import from Workshop**.
- Import dashboard CSS from **Board settings → Custom CSS → Import from Workshop**.
## Share your work
Custom Widget credentials are configured in your Homarr instance and are not part of the Workshop submission.
For a saved Custom Widget, open **Management → Custom Widgets**, use its action menu, and select **Publish to
Workshop**. Review the public listing details and source URLs, then publish the credential-free export. Custom CSS and
manual submissions can be shared directly from the Workshop website with **Share yours**.
## Publish content
Publishing creates the listing immediately. To update or delete it, review reports, or mark it outdated, open the
Workshop website, sign in, and select **Yours**. Editing a submission does not change its Workshop URL.
Publish a saved Custom Widget from its action menu under **Management → Custom Widgets**. Custom CSS and manual
submissions can be published from the Workshop website.
## Voting, comments, and reports
Sign in to the Workshop and open **Yours** to update or delete submissions and review reports. Signed-in users can vote,
comment, and report content; Workshop moderators can remove content. Workshop moderation is separate from administration
of a Homarr instance.
Signed-in users can vote, comment, and report submissions. Authors can edit their own comments and submissions.
Workshop moderators can review reports, remove comments, and delete unsafe content. Reports do not remove a submission
automatically.
A Workshop moderator manages the public community. This is separate from the administrator role on a Homarr instance.
Deployment and server configuration are in the [Workshop operator guide](./operator). Local setup is in
[Workshop development](./development).
See the [Workshop operator guide](/docs/advanced/development/workshop-operator) to host Workshop or
[Workshop development](/docs/advanced/development/workshop) to run it from the repository.