Skip to content

Improve structure / de-duplicate #181

@shawaj

Description

@shawaj

Describe the bug

Right now we have duplication of lots of information. For example lots of troubleshooting info in the outdoor and indoor sections that are identical.

This is bad for a few reasons:

  1. It is confusing to have the same info in lots of places
  2. It adds significant extra overhead to maintain the same information in several places
  3. It is very likely that we will forget to update in all locations due to (2) above meaning that we will have differing information in multiple places, adding further confusion.

This is already happening in several places and will only get worse as the amount of content increases.

Expected behavior

We should improve the structure of the documentation so that we only have information in a single place about a single subject and don't duplicate... If we want to have the information in multiple places we should provide internal links rather than duplicating.

For example, this can be achieved in the troubleshooting pages by having:

  • overall troubleshooting
  • indoor troubleshooting
  • outdoor troubleshooting
  • light troubleshooting
  • etc etc for new devices

The main troubleshooting can then link to the sub sections and the sub sections back to the main troubleshooting. In the main one should be troubleshooting relevant to all products, in the sub sections should be ones specific to that variant.

The same goes for the FAQ, onboarding and various other sections that are common to all devices.

This will be a major improvement and set us up nicely for the future.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions