Skip to content

docs: user-first public onboarding and M3.H community consolidation - #316

Merged
masarray merged 2 commits into
mainfrom
docs/public-first-onboarding-m3h-20261024
Oct 24, 2026
Merged

masarray merged 2 commits into
mainfrom
docs/public-first-onboarding-m3h-20261024

Conversation

@masarray

Copy link
Copy Markdown
Owner

Goal

Make ARStack approachable for first-time electrical and automation engineers while preserving accurate engineering evidence and the existing M3.H stable binaries.

Public-facing changes

  • Rewrite README around what ARStack does, how to install and the first IEC 61850 SV/PTP experiment.
  • Add click-by-click Getting Started guide, support, contributing, community interoperability guide, and issue forms.
  • Move internal implementation guidance behind a concise developer documentation index; retain existing detailed records.
  • Refresh Studio README and M3.H release documentation with clear features/downloads first; retain exact PCAP measurements, notes, hashes and source provenance.
  • Synchronize feature matrix with M3.H and improve product website copy.
  • Extend product naming guard to new public-facing entrypoints.

Safety / scope

  • Documentation and site copy only, plus naming-guard script.
  • No changes to ESP32-P4 firmware, timing/servo, SV framing, ARStack Studio runtime, binary artifacts or immutable GitHub release/tag.
  • Public communications remain vendor-neutral; historic interoperability evidence stays intact.

Acceptance

  • Product Naming Guard passes.
  • Landing Browser/Mobile acceptance passes.
  • Verify all user-facing links, forms and GitHub Pages deployment.
  • GitHub About fields and Discussions require separate repository-setting edits (not covered by code PR).

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-24T11:22:54.418231Z 3aa76c5 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 3aa76c5881

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/GETTING_STARTED.md
Comment on lines +33 to +35
1. In Studio, open **Configuration → Firmware**.
2. Select the ESP32-P4 device and use **Verify ESP32-P4**.
3. Choose **Install / Recover** to install the firmware provided with this Studio release.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Match the firmware tutorial to the shipped Studio controls

For first-time users installing M3.H firmware, these steps reference controls that do not exist in the shipped application. In the pinned release source a922e9bdba4e57a4e88406eb83344455dd8ff142, ModernRibbon.qml exposes Advanced, not Configuration, and FirmwarePanel.qml offers Update firmware, Install bundled build, or Reinstall current, rather than Verify ESP32-P4 and Install / Recover. Update this tutorial and the equivalent release instructions to describe the actual recovery/install flow so users with an unprovisioned board can complete onboarding.

Useful? React with 👍 / 👎.

@masarray
masarray merged commit 2fd3f83 into main Oct 24, 2026
13 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.

1 participant