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

Some feedback and suggestions for improvement #1

Open
lnlp opened this issue Jan 13, 2020 · 1 comment
Open

Some feedback and suggestions for improvement #1

lnlp opened this issue Jan 13, 2020 · 1 comment

Comments

@lnlp
Copy link

lnlp commented Jan 13, 2020

Some feedback and suggestions for improvement:

  • Having a large detailed Table of Contents ('Contents') on the start page that includes the contents of all documentation is confusing, distracting and too much detail.
    Confusing because it looks like the table of contents of several different 'books' (subjects) i.e. CubeCell, ESP32 + LORA and General Docs.

    My suggestion would be to keep the opening page brief and simple and only include an introduction and links to the three above mentioned subjects.

  • It will be better to have a separate table of contents per subject.
    (If I'm looking for CubeCell information I don't want to be bothered with ESP32 + LoRa contents.)

  • The information structure ('table of contents') is in fact already provided in the navigation tree on the left. However, having a separate page with list of contents can sometimes be useful, e.g. for printing. I would like to suggest to add Contents as a separate topic per subject (the first topic per subject) so the user can decide to open or skip it.

  • A separate topic for the HTCC-AB01 Board is missing.
    (HTCC-AB01 specific information should be separate from generic CubeCell information that is relevant for all CubeCell products.)

  • CUBECELL / CubeCell is double and confusing.
    My suggestion would be to structure the information as follows:

    Example:

    CUBECELL
        + Contents
        + Installation
        + Uploading and running code (examples)
        + LoRaWAN
            + Configuration Parameters
            + Connect to LoRaWAN server
            + AT Command List
        + HTCC-AM01 Module
            + etc.
        + HTCC-AB01 Board
            + etc.
        + HTCC-AC01 Capsule Sensor
            + etc.
        + Frequently Asked Questions

    ESP32+LORA
        + Contents
        + etc.
  • In the navigation tree, do NOT link to external documents directly:
    The 'AT Command List' item in the navigation tree links to and opens an external PDF document in the browser but also leaves the Heltec Automation Docs website.
    Link from the navigation tree to a separate AT Command List page.
    On that page add the link to the external PDF document (if possible as 'open in new tab').
    Please also add the AT command list as a normal content on that page (not just a link to pdf) so it integrates nicely with the rest of the documentation.

  • If possible do NOT collapse topics in the navigation tree when the user switches from one topic to another because it makes simple switching between two or more pages (from different topics) impossible (requires the user to perform multiple selections/mouse clicks when switching because collapsing hides the links to pages from other topics).

Use of English Langue

  • I think that the correct English term for 'Capsule Sensor' is 'Sensor Capsule'.
    Because the capsule (not a sensor) is the main subject.
    (Sensor Capsule refers to the capsule while Capsule Sensor refers to a sensor for the capsule.)

  • Summary
    A summary is a brief text that summarizes the essentials of all contents.
    ALL occurences of 'Summary' are NOT a summary, for example:
    CubeCell / Quick Start / Summary is NOT a summary.
    Therefore the 'Summary' titles can be removed, or in some cases where the 'summary' text contains mainly warnings, 'Summary' can be replaced with 'Notes' or 'Remarks'.

  • There are some spelling errors (e.g. Summary, not Sammary).

@Heltec-Aaron-Lee
Copy link
Contributor

Thank you very much for your suggestions!!! It's very important for us.

vxzyfx added a commit that referenced this issue Jan 31, 2023
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

No branches or pull requests

2 participants