Skip to content

Conversation

@mike-scott
Copy link
Contributor

Add a single page set of instructions guiding new users of the UNO Q towards fioup documentation. And also remind them to check for the latest base image from Arduino in order to avoid any support issues.

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

Why merge this PR? What does it solve?

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

@mike-scott mike-scott self-assigned this Oct 14, 2025
@mike-scott
Copy link
Contributor Author

NOTE: This will also need a marketing review / approval prior to merging.

@mike-sul
Copy link
Contributor

@mike-scott IMO, the UNOQ doc should include a guide or a link to one on "container-only" factory creation. A user cannot use fioup on UNOQ until he/she:

  1. Creates the container-only factory (this is the missing part).
  2. Registering device (explained in the fioup getting started doc).
  3. Installing fioup (explained in the fioup getting started doc).

Copy link
Contributor

@kprosise kprosise left a comment

Choose a reason for hiding this comment

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

Minor suggestions made, mostly related to semantic newlines, as well as trademark usage

@doanac
Copy link
Member

doanac commented Oct 15, 2025

Its rendering in our main index page weird; there are two links:
image

Add a single page set of instructions guiding new users of the UNO Q towards
fioup documentation. And also remind them to check for the latest base image
from Arduino in order to avoid any support issues.

Signed-off-by: Michael Scott <mike@foundries.io>
Co-authored-by: Katrina Prosise <katrina.prosise@foundries.io>
@mike-scott
Copy link
Contributor Author

@mike-scott IMO, the UNOQ doc should include a guide or a link to one on "container-only" factory creation. A user cannot use fioup on UNOQ until he/she:

  1. Creates the container-only factory (this is the missing part).
  2. Registering device (explained in the fioup getting started doc).
  3. Installing fioup (explained in the fioup getting started doc).

I've tried to cover a more complete workflow in the latest version.

@mike-scott mike-scott merged commit 6a6f673 into foundriesio:main Oct 15, 2025
1 of 3 checks passed
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.

5 participants