Supported devices list

[glpnk]

Part of project documentation

Plans for next PRs:

• rewrite memory map
• add RWEverything guide

[teackot]

How about listing supported features, something like:

Model	Class	EC name	Extras	Link	Battery thresholds	webcam	...
Cool Laptop 15	Business	12345678			+	-	...

[glpnk]

@teackot my last thougths was about using Discussions for supported models and other documentation

[teackot]

Like using discussions as docs pages? I think this way docs will be lost among questions and firmware requests

We can also use github's wiki feature for this

[teackot]

Though the issue with the wiki is that only I and BeardOverflow will be able to edit it. But it would work nice for documenting different features the driver exposes in sysfs. That is, "Usage" section of the current readme.md

[glpnk]

This is my second attempt to create "low level" documentation. Also how to implement usable memory map table from #36.

I think mixing code with docs inside same repo is bad, because at least it messing with commit history.

[glpnk]

@teackot What do you think about creating repo for wiki repo content? Like you do for issue template

[teackot]

What do you think about creating repo for wiki repo content? Like you do for issue template

I only created issue template repo as a demonstration, it is already merged into this repo. I think creating separate repos for stuff will cause too much fragmentation for a small driver project

[teackot]

@glpnk Oh, I just found out that github wiki can be edited by contributors and is in fact a separate git repo that you can clone and edit locally, it just needs to be enabled in the repo settings

[glpnk]

Yeah, I know that wiki is something like repo.wiki.git but I thought that is creator editable only.

Also what we need to collect in wiki?

• Text from readme
• Device list
• Device/FW to address map
• Windows guide
• Linux only guide
• Safety precautions

May be

• Collection of EC dumps

[teackot]

Yes

We can make a single contribution guide with a Windows section, a Linux section, and a section about creating a new configuration in the code

[glpnk]

@teackot Okay. Not related to this theme but what you think about #48 and similar cases and single FW record for two+ different models? Or it pointless in case of possible structural redesign?

[teackot]

I will reply in #48

[teackot]

@glpnk BeardOverflow gave contributors access to the wiki, see if you can edit it

[rottenpants466]

Maybe do something similar to this?

https://github.com/dmitry-s93/MControlCenter/blob/main/docs/tested_devices.md

[teackot]

Maybe do something similar to this?

https://github.com/dmitry-s93/MControlCenter/blob/main/docs/tested_devices.md

I think it's a good idea to do a similar table. We already have a list of laptops in README and we can just put them in a separate file with a simple list of features for each machine.

I also think we should put it in the /docs directory of the repo instead of the wiki. Wiki is nice, but it is harder to modify and keep track of.

[teackot]

See: #116

[glpnk]

Deprecated, feel free to reuse