You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
It is confusing to have the same info in lots of places
It adds significant extra overhead to maintain the same information in several places
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.
The text was updated successfully, but these errors were encountered:
@shawaj Thanks for raising the issue and I agree with you.
Like you said we make a common troubleshooting guide, then reference all the troubleshooting links on that page section depends on the device with an internal link. so the structure will be the same, but there will be only one main page for all the troubleshooting.
For common troubleshooting guides like "sync issue" ..etc will be added under the main troubleshooting guide add a link to the device-specific contents list.
@shawaj please check and let me know your comments.
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:
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:
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.
The text was updated successfully, but these errors were encountered: