ddcutil icon indicating copy to clipboard operation
ddcutil copied to clipboard

Contributing to docs

Open fabian-thomas opened this issue 4 years ago • 3 comments

I wanna change this page in the docs. Where do I find the sources for the docs so I can set up a PR?

fabian-thomas avatar Aug 03 '21 17:08 fabian-thomas

The document source is maintained offline, and the generated html pages are uploaded.  Please send the changes you would like to see.  I will review and incorporate them as appropriate.  If the changes are extensive, submit them as an attachment. Thank you.

On 8/3/21 1:30 PM, Fabian Thomas wrote:

I wanna change this page https://www.ddcutil.com/command_detect/ in the docs. Where do I find the sources for the docs so I can set up a PR?

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/rockowitz/ddcutil/issues/215, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADMGY3QJXA55QU3QR4Q7WQDT3ARUBANCNFSM5BPI7ORA. Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&utm_campaign=notification-email.

rockowitz avatar Aug 03 '21 17:08 rockowitz

In command_detect:

Currently at the end the page says: Option: --verbose Show additional information, including the EDID.

When I run (version 1.1.0) ddcutil detect --verbose I don't get the EDID information. Only if it's there. For querying that you need to use --very-verbose. You could just change the --verbose to --very-verbose and mention that there's also a verbose mode with less options.

fabian-thomas avatar Aug 03 '21 17:08 fabian-thomas

Thank you for pointing out the discrepancy between the documentation for command detect and its current behaviour. The current development branch, 1.2.0- dev, has been modified to be consistent with the behaviour. The online documentation will be updated once version 1.2.0 is released.

--very-verbose is an undocumented option whose output can vary over time as needed for remote problem diagnosis. Help output in 1.2.0-dev has been modified to not report it.

rockowitz avatar Aug 11 '21 04:08 rockowitz

Closing this because in the newest version the diff between verbose and very-verbose is zero. So the documentation is fine.

fabian-thomas avatar Aug 19 '22 08:08 fabian-thomas