Skip to content
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.

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

Docs: Improve Device Agent Intro Documentation #4718

Merged
merged 9 commits into from
Nov 1, 2024
Merged

Conversation

joepavitt
Copy link
Contributor

Description

  • Our "Device Agent" landing page has a CTA which links to the "Quick Start" for Device Agent
  • The Quick Start wasn't labelled accordingly, and was quite dis-jointed, text heavy and overwhelming for new visitors, these changes aim to improve that.

Related Issue(s)

Uses graphic from FlowFuse/website#2670
Also utilises {data-zoomable} being supported once FlowFuse/website#2725 is merged.

@joepavitt
Copy link
Contributor Author

FYI @Yndira-E

Copy link
Contributor

@Steve-Mcl Steve-Mcl left a comment

Choose a reason for hiding this comment

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

some small suggestions

docs/device-agent/quickstart.md Outdated Show resolved Hide resolved
docs/device-agent/quickstart.md Outdated Show resolved Hide resolved
docs/device-agent/quickstart.md Show resolved Hide resolved
joepavitt and others added 2 commits November 1, 2024 11:18
Co-authored-by: Stephen McLaughlin <44235289+Steve-Mcl@users.noreply.github.com>
Co-authored-by: Stephen McLaughlin <44235289+Steve-Mcl@users.noreply.github.com>
Steve-Mcl and others added 2 commits November 1, 2024 11:21
Co-authored-by: Stephen McLaughlin <44235289+Steve-Mcl@users.noreply.github.com>
Copy link
Contributor

@Steve-Mcl Steve-Mcl left a comment

Choose a reason for hiding this comment

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

I approve :) - but there is one point I made about the "full instructions" link - we could argue it is in the right place (a foot note) however due to document structure it appears to only be part of the windows install instrcutions.

Happy to ignore and move on (pre-emptive approval)

docs/device-agent/quickstart.md Outdated Show resolved Hide resolved
@joepavitt joepavitt merged commit 9b8fffc into main Nov 1, 2024
8 checks passed
@joepavitt joepavitt deleted the docs-device-agent branch November 1, 2024 14:31
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.

2 participants