Skip to content

Re-enable the documentation checks #8024

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dimitrieh wants to merge 3 commits into
base: main
Choose a base branch
from
+5 −7
Open

Re-enable the documentation checks #8024

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cbddd92
Re-enable documentation checks
dimitrieh Aug 3, 2026
bc90b11
Merge branch 'main' into re-enable-docs-checks
dimitrieh Aug 3, 2026
b71ea99
Fix five broken (optional) anchors in the docs
dimitrieh Aug 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ on:
- 'docs/**'
jobs:
test:
if: false
runs-on: ubuntu-latest
name: Test Documentation links
steps:
Expand All @@ -24,7 +23,6 @@ jobs:
- name: Test Documentation Links
run: npm run test:docs
test-with-website:
if: false
runs-on: ubuntu-latest
name: Test Documentation with website
steps:
Expand Down
4 changes: 2 additions & 2 deletions docs/device-agent/deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ When running in the default of Fleet Mode, the device agent does not allow local
Node-RED editor. This ensures the Remote Instance is running the deployed snapshot without modification.

When running on FlowFuse Cloud, or a premium licensed FlowFuse instance (with the
[MQTT broker enabled](https://flowfuse.com/docs/contribute/local/#setting-up-mosquitto-(optional)))
[MQTT broker enabled](https://flowfuse.com/docs/contribute/local/#setting-up-mosquitto-optional))
the Remote Instance can be placed in Developer Mode that enables remote access to the editor.

This can then be used to develop the flows directly on the Remote Instance and a new snapshot
Expand Down Expand Up @@ -72,7 +72,7 @@ Access to the editor is only available when:
* The Remote Instance is in Developer Mode

* When running on FlowFuse Cloud, or a premium licensed FlowFuse instance (with the
[MQTT broker enabled](https://flowfuse.com/docs/contribute/local/#setting-up-mosquitto-(optional))
[MQTT broker enabled](https://flowfuse.com/docs/contribute/local/#setting-up-mosquitto-optional)
the Remote Instance can be placed in Developer Mode that enables remote access to the editor.

* Local access to the editor can be enabled by defining a Username & Password in the Device
Expand Down
4 changes: 2 additions & 2 deletions docs/install/docker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Before you begin, ensure you have the following:

For a production-ready environment, we also recommend:
* **Database:** Prepare dedicated database on a external database server (see [FAQ](#how-to-use-external-database-server%3F) for more details)
* **TLS Certification:** Prepare TLS certificate for your domain and configure FlowFuse platform to use it (see [Enable HTTPS](#enable-https-(optional)))
* **TLS Certification:** Prepare TLS certificate for your domain and configure FlowFuse platform to use it (see [Enable HTTPS](#enable-https-optional))

### Requirements

Expand Down Expand Up @@ -291,7 +291,7 @@ Once ready, [start the application](#start-flowfuse-platform) .

### How can I provide my own TLS certificate?

If you have your own TLS certificate, you can use it in FlowFuse platform installation as well. See [Enable HTTPS](#enable-https-(optional)) section for more details.
If you have your own TLS certificate, you can use it in FlowFuse platform installation as well. See [Enable HTTPS](#enable-https-optional) section for more details.

Additionally, if your TLS certificate is issued by a private Certificate Authority, you will need to perform some additional configuration to make hosted Node-RED instances trust the CA. See [What additional configuration is required when the TLS certificate is issued by a private Certificate Authority](#what-additional-configuration-is-required-when-the-tls-certificate-is-issued-by-a-private-certificate-authority%3F) for the step-by-step instructions.

Expand Down
2 changes: 1 addition & 1 deletion docs/upgrade/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ This release introduces an MQTT Broker into the FlowFuse platform used to commun
between devices and the core platform.

For LocalFS users, they will need to manually setup the broker and ensure it is
properly configured. The documentation for this is available [here](../contribute/local#setting-up-mosquitto-(optional))
properly configured. The documentation for this is available [here](../contribute/local#setting-up-mosquitto-optional)

#### LocalFS Users

Expand Down
Loading