Add TAPPER section #141

Martian-0007 · 2025-05-11T20:06:46Z

Add a section for the TAPPER Product.

netlify · 2025-05-11T20:06:51Z

✅ Deploy Preview for hardwario-docs ready!

Name	Link
🔨 Latest commit	`faf3be8`
🔍 Latest deploy log	https://app.netlify.com/projects/hardwario-docs/deploys/683dbe95583bdc0008c9ca98
😎 Deploy Preview	https://deploy-preview-141--hardwario-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot

Pull Request Overview

This PR adds a new documentation section for the TAPPER product, outlining its usage, installation, API specification, and introduction, along with updating the sidebar and Docusaurus configuration.

Introduces a usage guide with command descriptions and configuration options
Adds an introduction page outlining core features and product capabilities
Provides installation instructions and MQTT API documentation, and updates sidebar and config files accordingly

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
tapper/usage.md	Adds client CLI usage instructions and configuration reference.
tapper/introduction.md	Introduces TAPPER with features; contains minor spelling issues.
tapper/installation.md	Provides detailed installation steps for the TAPPER client.
tapper/api-spec.md	Documents the MQTT API specification for TAPPER.
sidebars-tapper.js	Configures the sidebar for the TAPPER documentation section.
docusaurus.config.js	Updates Docusaurus configuration to include the TAPPER docs.

tapper/introduction.md

tapper/api-spec.md

Martian-0007 · 2025-05-26T09:12:05Z

The checks failed on initialization - failed to enqueue.
Ideally, could we re-run the checks?

Copilot

Pull Request Overview

This PR adds a new documentation section for the TAPPER Product, detailing client usage, installation, API specifications, and an introduction.

New markdown files for usage, introduction, installation, and API specification
Integration of the TAPPER section into the Docusaurus sidebars and configuration

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
tapper/usage.md	New usage documentation for TAPPER CLI commands
tapper/introduction.md	Introduction and overview of TAPPER features
tapper/installation.md	Installation guide including prerequisites and steps
tapper/api-spec.md	MQTT API specification details for TAPPER
sidebars-tapper.js	Sidebar configuration for the TAPPER documentation
docusaurus.config.js	Updated configuration to include the new tapper docs

tapper/installation.md

Copilot

Pull Request Overview

Adds the initial documentation and site configuration for the new TAPPER product section.

Introduces four new docs: Introduction, Installation, Usage, and API Specification.
Registers the TAPPER docs in the sidebar and adds a top‐level “TAPPER” nav entry.
Updates docusaurus.config.js to include the new docs plugin.

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
tapper/usage.md	Add CLI usage instructions and configuration snippet
tapper/introduction.md	Add project overview and feature list
tapper/installation.md	Add step‐by‐step installation guide for Raspberry Pi
tapper/api-spec.md	Add detailed MQTT API specification with topics and payloads
sidebars-tapper.js	Define sidebar entries for the TAPPER docs
docusaurus.config.js	Register the TAPPER docs plugin and add a “TAPPER” navbar link

Comments suppressed due to low confidence (2)

tapper/introduction.md:16

[nitpick] The indent on this bullet is inconsistent with the others. Remove the extra spaces so it aligns with the list.

  - TLS connection is currently work-in-progress

docusaurus.config.js:106

The new docs plugin block needs its editUrl indented inside the same object (like the apps plugin) so that the “Edit this page” link works for Tapper docs.

        sidebarPath: require.resolve('./sidebars-tapper.js'),

tapper/usage.md

tapper/api-spec.md

Signed-off-by: Martin <81148675+Martian-0007@users.noreply.github.com>

- Add Installation - Add Usage - Rewrite Introduction - Moved MQTT API to a separate file, this is yet to be finished Signed-off-by: Martin <81148675+Martian-0007@users.noreply.github.com>

Signed-off-by: Martin <81148675+Martian-0007@users.noreply.github.com>

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Typo Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

- Fix typos in Installation - Add information to Installation - Improve readability of Usage Signed-off-by: Martin <81148675+Martian-0007@users.noreply.github.com>

- Remove redundant topics from Request response Signed-off-by: Martin <81148675+Martian-0007@users.noreply.github.com>

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Signed-off-by: Martian <81148675+Martian-0007@users.noreply.github.com>

- Add Hardware Description (WIP) - Fix mistakes (ran through Grammarly) - Reformat with prettier Signed-off-by: Martian <81148675+Martian-0007@users.noreply.github.com>

Copilot

Pull Request Overview

Add comprehensive documentation for the new TAPPER product, including usage, installation, hardware specs, TLS setup, and API specification, and integrate it into the site sidebar and navigation.

Introduce TAPPER documentation pages under tapper/
Update sidebar and Docusaurus configuration to include the TAPPER section

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
tapper/introduction.md	Added high-level introduction to TAPPER
tapper/installation.md	Added step-by-step client installation guide
tapper/hardware.md	Added hardware specifications and schematics
tapper/tls-setup.md	Added MQTT over TLS setup instructions
tapper/usage.md	Added CLI usage and configuration reference
tapper/api-spec.md	Added MQTT API specification
sidebars-tapper.js	Defined sidebar order for TAPPER docs
docusaurus.config.js	Registered TAPPER docs plugin and added navbar item

Comments suppressed due to low confidence (1)

docusaurus.config.js:107

The editUrl line is misindented and placed outside the plugin object for the TAPPER docs—move it inside the ({ ... }) block passed to @docusaurus/plugin-content-docs.

          editUrl: 'https://github.com/hardwario/docs/edit/main',

tapper/usage.md

tapper/tls-setup.md

tapper/introduction.md

tapper/hardware.md

Signed-off-by: Martian <81148675+Martian-0007@users.noreply.github.com>

Copilot

Pull Request Overview

This PR adds a TAPPER section to the documentation covering client usage, TLS setup, API specifications, and hardware and installation guides.

Added comprehensive CLI usage instructions for TAPPER in tapper/usage.md
Provided detailed TLS setup and API specification guides in tapper/tls-setup.md and tapper/api-spec.md
Updated supplementary documents (introduction, installation, hardware) and configuration files for integrated navigation

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
tapper/usage.md	New CLI usage documentation for TAPPER
tapper/tls-setup.md	TLS certificate generation and Mosquitto setup guide
tapper/introduction.md	Introduction and product overview for TAPPER
tapper/installation.md	Instructions for installing and setting up the TAPPER client
tapper/hardware.md	Hardware specifications and schematics for TAPPER
tapper/api-spec.md	MQTT API specifications for TAPPER communication
sidebars-tapper.js	Sidebar configuration for the new TAPPER documentation
docusaurus.config.js	Updated configuration to include the TAPPER docs route

tapper/tls-setup.md

tapper/api-spec.md

Signed-off-by: Martian <81148675+Martian-0007@users.noreply.github.com>

Martian-0007 force-pushed the martinz/tapper branch from d009bc8 to 60192d6 Compare May 25, 2025 21:39

Martian-0007 requested a review from Copilot May 26, 2025 09:10

Martian-0007 marked this pull request as ready for review May 26, 2025 09:10

Copilot AI reviewed May 26, 2025

View reviewed changes

tapper/introduction.md Outdated Show resolved Hide resolved

tapper/introduction.md Outdated Show resolved Hide resolved

tapper/api-spec.md Outdated Show resolved Hide resolved

Martian-0007 requested review from Copilot and SmejkalJakub May 26, 2025 09:18

Copilot AI reviewed May 26, 2025

View reviewed changes

tapper/installation.md Outdated Show resolved Hide resolved

Martian-0007 requested a review from Copilot May 26, 2025 14:19

Copilot AI reviewed May 26, 2025

View reviewed changes

tapper/usage.md Show resolved Hide resolved

tapper/usage.md Show resolved Hide resolved

tapper/api-spec.md Outdated Show resolved Hide resolved

Martian-0007 and others added 16 commits May 31, 2025 22:35

Add TAPPER section

95b1185

Signed-off-by: Martin <81148675+Martian-0007@users.noreply.github.com>

Update TAPPER docs to match version 1.0.3

43acede

- Add Installation - Add Usage - Rewrite Introduction - Moved MQTT API to a separate file, this is yet to be finished Signed-off-by: Martin <81148675+Martian-0007@users.noreply.github.com>

Add MQTT specification for TAPPER

d6bc587

Signed-off-by: Martin <81148675+Martian-0007@users.noreply.github.com>

Update api-spec.md

00cee80

Update introduction.md

7e87731

Update tapper/introduction.md

3738aa5

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update tapper/api-spec.md

0bb703e

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update tapper/installation.md

086ebe8

Typo Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update TAPPER docs

a54bc93

- Fix typos in Installation - Add information to Installation - Improve readability of Usage Signed-off-by: Martin <81148675+Martian-0007@users.noreply.github.com>

Update API Specs

5f593b1

- Remove redundant topics from Request response Signed-off-by: Martin <81148675+Martian-0007@users.noreply.github.com>

Update tapper/api-spec.md

86264e5

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Add TLS

ed81665

Signed-off-by: Martian <81148675+Martian-0007@users.noreply.github.com>

Add information about pipx path esnuring

779e8f2

Signed-off-by: Martian <81148675+Martian-0007@users.noreply.github.com>

Format TAPPER with prettier

d2c74cd

Signed-off-by: Martian <81148675+Martian-0007@users.noreply.github.com>

Fix typo in TAPPER installation

4b7d6a8

Signed-off-by: Martian <81148675+Martian-0007@users.noreply.github.com>

Add Hardware, fix mistakes and reformat

5c5f509

- Add Hardware Description (WIP) - Fix mistakes (ran through Grammarly) - Reformat with prettier Signed-off-by: Martian <81148675+Martian-0007@users.noreply.github.com>

Martian-0007 force-pushed the martinz/tapper branch from a7d592c to 5c5f509 Compare May 31, 2025 20:35

Martian-0007 requested a review from Copilot May 31, 2025 20:36

Copilot AI reviewed May 31, 2025

View reviewed changes

tapper/usage.md Outdated Show resolved Hide resolved

tapper/tls-setup.md Outdated Show resolved Hide resolved

tapper/introduction.md Outdated Show resolved Hide resolved

tapper/hardware.md Outdated Show resolved Hide resolved

Martian-0007 added 4 commits May 31, 2025 22:40

Fix typos in TAPPER

e858fd4

Signed-off-by: Martian <81148675+Martian-0007@users.noreply.github.com>

Reorder TAPPER sidebar

c3bbe86

Signed-off-by: Martian <81148675+Martian-0007@users.noreply.github.com>

Fix language in TAPPER

0599d12

Signed-off-by: Martian <81148675+Martian-0007@users.noreply.github.com>

Reodred TAPPER Sidebar

82ae335

Signed-off-by: Martian <81148675+Martian-0007@users.noreply.github.com>

Martian-0007 requested a review from Copilot May 31, 2025 20:59

Copilot AI reviewed May 31, 2025

View reviewed changes

tapper/tls-setup.md Outdated Show resolved Hide resolved

tapper/api-spec.md Outdated Show resolved Hide resolved

Martian-0007 added 3 commits May 31, 2025 23:00

Polish TAPPER

0a1da41

Signed-off-by: Martian <81148675+Martian-0007@users.noreply.github.com>

Fix formatting and add schematics PDF to TAPPER

3e4ac8d

Signed-off-by: Martian <81148675+Martian-0007@users.noreply.github.com>

Improve TAPPER hardware spec table

faf3be8

Signed-off-by: Martian <81148675+Martian-0007@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add TAPPER section #141

Add TAPPER section #141

Uh oh!

Martian-0007 commented May 11, 2025

Uh oh!

netlify bot commented May 11, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Martian-0007 commented May 26, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Add TAPPER section #141

Are you sure you want to change the base?

Add TAPPER section #141

Uh oh!

Conversation

Martian-0007 commented May 11, 2025

Uh oh!

netlify bot commented May 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for hardwario-docs ready!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Martian-0007 commented May 26, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

netlify bot commented May 11, 2025 •

edited

Loading