Skip to content

docs: update documentation to align with 2.30 #7223

Merged
dimitrieh merged 14 commits into
mainfrom
update-docs-2-30
May 7, 2026
Merged

docs: update documentation to align with 2.30 #7223
dimitrieh merged 14 commits into
mainfrom
update-docs-2-30

Conversation

@sumitshinde-84
Copy link
Copy Markdown
Contributor

@sumitshinde-84 sumitshinde-84 commented May 7, 2026

Description

Documentation updates across multiple areas to reflect changes shipped in 2.30

Related Issue(s)

closes FlowFuse/website#4936

Checklist

  • I have read the contribution guidelines
  • Suitable unit/system level tests have been added and they pass
  • Documentation has been updated
    • Upgrade instructions
    • Configuration details
    • Concepts
  • Changes flowforge.yml?
    • Issue/PR raised on FlowFuse/helm to update ConfigMap Template
    • Issue/PR raised on FlowFuse/CloudProject to update values for Staging/Production
  • Link to Changelog Entry PR, or note why one is not needed.

Labels

  • Includes a DB migration? -> add the area:migration label

@sumitshinde-84 sumitshinde-84 changed the title Documents update to align with 2.30 docs: update documentation to align with 2.30 May 7, 2026
@sumitshinde-84 sumitshinde-84 marked this pull request as ready for review May 7, 2026 11:51
Copy link
Copy Markdown
Contributor

@hardillb hardillb left a comment

Choose a reason for hiding this comment

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

Where did the suggested SSO changes come from? they are incorrect and not what is described in both the code or the docs I had already updated.

Comment thread docs/admin/sso/README.md Outdated
Comment thread docs/admin/sso/saml.md Outdated
@sumitshinde-84
Copy link
Copy Markdown
Contributor Author

sumitshinde-84 commented May 7, 2026

@hardillb The comment in the table says “all users" I assumed it included admins as well. Thanks for reviewing, I’ve removed the warning and the sentence you suggested removing.

@dimitrieh Also, regarding the self-hosted updates for next release, I’ll need more information since I cannot test the feature myself.

sumitshinde-84 and others added 2 commits May 7, 2026 18:05
Co-authored-by: Ben Hardill <ben@flowforge.com>
@dimitrieh
Copy link
Copy Markdown
Contributor

Audit against 2.30 features

Looks good overall. Every user-facing 2.30 feature has corresponding docs, with framing that matches the release blog post and our agreed soft-launch language for agentic application building.

2.30 feature Documented? Where
Agentic Expert application building (lead) Yes chat.md adds "Building Flows on the Canvas" under Support Mode (gif, sample prompts, availability callout); expert/index.md overview updated
Immersive editor drawer (no overlap, pin/move/fullscreen) Yes instance-settings.md new paragraph + screenshot; chat.md references it alongside the chat description
Snapshot comparison polish Yes, comprehensive snapshots.md rewritten: 3-panel layout, Added/Deleted/Changed status, node-type badges, Prettify/Wrap toggles, computed properties excluded, position-only changes can be hidden
Force all users to use SSO Yes saml.md new "Forcing All Users to Use SSO" section + screenshot; sso/README.md softened to "By default, admin users can still log in"

One thing worth confirming, @sumitshinde-84: chat.md removed the 2.29 "Expert panel opens automatically when you enter the immersive editor" paragraph and screenshot. The behaviour itself didn't change in 2.30, so I think it should stay (potentially as a smaller note now that the agentic flow building section takes more room). Was the removal deliberate or did it get displaced when you added the new section?

Smaller items intentionally not documented (markdown code-block fix, device editor auto-recovery, audit log stop reasons) all look like reasonable omissions for docs.

The instance-settings.md TOC restructure (nested headings with H4 anchors) isn't tied to a 2.30 feature but reads like a useful cleanup, so no concern.

@dimitrieh
Copy link
Copy Markdown
Contributor

dimitrieh commented May 7, 2026

@sumitshinde-84 When this merges, please add the docs link back to website#4964 (the 2.30 changelog for FlowFuse Expert agentic building):

For usage guidance, see the [Building Flows on the Canvas](/docs/user/expert/chat/#building-flows-on-the-canvas) docs.

I temporarily removed it in website@08901c8 because the website hyperlink check fails on the missing anchor (CI builds against flowfuse@main).

@dimitrieh dimitrieh requested a review from hardillb May 7, 2026 14:09
@dimitrieh
Copy link
Copy Markdown
Contributor

Also, regarding the self-hosted updates for next release, I’ll need more information since I cannot test the feature myself.

Can you elaborate? We are just in a state where we can't enable this yet for SH enterprise clients. That is coming for next release

Comment thread docs/user/expert/chat.md Outdated
Comment thread docs/user/expert/chat.md
While in Immersive Mode you also have access to all [instance settings](/docs/user/instance-settings/) from a drawer that sits beside the canvas. You can manage environment variables, snapshots, the palette, and other settings without leaving the editor. Use the eye icon at the top of the drawer to move it left or right, pin or unpin it, or toggle fullscreen mode.

> **Note:** As of v2.29, the FlowFuse Expert panel opens automatically when you enter the immersive editor. If you close the panel, that preference is saved — Expert will remain closed on your next visit so it doesn't get in your way. You can reopen the Expert panel at any time by clicking the FlowFuse drawer button in the top-left of the editor.
> **Note:** Note: As of v2.29, the FlowFuse Expert panel opens automatically whenever you enter the FlowFuse platform or an instance. If you close the panel, your preference is saved — Expert will remain closed on your next visit so it doesnt get in your way. To open or close the panel while within the editor, click the FlowFuse drawer button in the top-left corner of the editor.
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.

To open or close the panel while within the editor, click the FlowFuse drawer button in the top-left corner of the editor.

@sumitshinde-84 👍 just FYI this might change soon. We can review next release

@dimitrieh dimitrieh self-requested a review May 7, 2026 14:52
Copy link
Copy Markdown
Contributor

@hardillb hardillb left a comment

Choose a reason for hiding this comment

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

Small addition

Comment thread docs/admin/sso/saml.md
Co-authored-by: Ben Hardill <ben@flowforge.com>
@sumitshinde-84 sumitshinde-84 requested a review from hardillb May 7, 2026 15:07
@dimitrieh dimitrieh merged commit 5d53428 into main May 7, 2026
15 checks passed
@dimitrieh dimitrieh deleted the update-docs-2-30 branch May 7, 2026 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Release 2.30: Docs site verification

3 participants