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

Sensor documentation #30

Open
8 tasks
Tracked by #31
oscgonfer opened this issue Nov 29, 2023 · 0 comments
Open
8 tasks
Tracked by #31

Sensor documentation #30

oscgonfer opened this issue Nov 29, 2023 · 0 comments
Assignees
Milestone

Comments

@oscgonfer
Copy link
Contributor

oscgonfer commented Nov 29, 2023

Currently we have three places where sensor information is added:

  1. Supported sensors page
  2. Sensor knowledge
  3. Guides for calibrating / using each sensor

For maintainability purposes, it would be great if we can do something similar to what we did in the mdef-docs for faculty and other content that can be processed by a macro.

Current proposal:

  • We move sensors performance/knowledge toc item to a nav item
  • We organise by:
- Sensors: brief explanation. Onboard and external. 
    - Air: brief explanation, supporting documents. Supported sensors summary with colors to distinguish onboard vs external.
        - CO2:  explanation of the metric, plus supported sensor cards (summary page)
            - Sensor 1,
            - Sensor 2...
        - PM:  explanation of the metric, plus supported sensor cards (summary page)
            - Sensor 1,
            - Sensor 2...
    - Water: brief explanation, supporting documents. Supported sensors summary with colors to distinguish onboard vs external.
        - pH: explanation of the metric, plus supported sensor cards (summary page)
            - Sensor 1,
            - Sensor 2...

An example is already found on the docs already: /hardware/sensors/air/co2/Sensirion_SCD30/

A good visual reference for this can be found on: https://blokas.io

TODO:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants