search

project-chip / certification-tool

A test harness and tooling designed to simplify development, testing, and certification for devices, guided by the Connectivity Standards Alliance.
https://csa-iot.org/
Apache License 2.0
38 stars 23 forks source link

[Bug] Userguide adoc version has gotten messed up ? #183

Closed raju-apple closed 7 months ago

raju-apple commented 7 months ago

Describe the bug

https://github.com/project-chip/certification-tool/tree/main/docs/Matter_TH_User_Guide

The .adoc version seems to be messed up now , has any PR broken this ?

Steps to reproduce the behavior

No response

Expected behavior

No response

Log files

No response

PICS file

No response

Screenshots

No response

Environment

No response

Additional Information

No response

hiltonlima commented 7 months ago

We separate the single .adoc file into several .adoc files. To make maintenance easier.

For the complete view the pdf file can be used as usual.

raju-apple commented 7 months ago

Hmm , multiple.adoc files is confusing though, are we making many changes to the user guide though? If not would prefer the older format as most developers use that format

fabiowmm commented 7 months ago

@raju-apple you mean confusing for users? They should use the pdf, we always update it when the doc changes.

raju-apple commented 7 months ago

PDF they’ll have to download, but what maintenance exactly is troubling that we wanted to break this up? If you click on table of contents it’s an empty page, having everything load is so much better instead

fabiowmm commented 7 months ago

ok, then. we'll revert it. @hiltonlima

raju-apple commented 7 months ago

Fixed , thanks folks !