Create System.Device.Gpio Overview doc

[dotnet]

Create System.Device.Gpio Overview doc

[RheaAyase]

Add link to System.Device.Gpio API README in main repo README markdown.

Information about contributing and building the project should be in CONTRIBUTING.md - it gets nicely popped out in front of everyone's face when they click "create pull request," etc...

[joperezr]

I'm not sure of concrete workitems that can come out of this. I know that you logged this some time ago and a bunch of changes to documentation have happened since, do you think this is still an issue? Is there a specific thing we should add to our existing docs?

[shaggygi]

I was originally thinking it would be good to have an overall doc that explained the basics down to more technical detail. Sort of explaining with diagrams and such for peeps to understand structure of things like device/controller and how it fits with with the different OS/hardware boards. I'm not sure the best format (markdown, slides, etc.), but the dust needs to settle (new talks of controllers, etc. before attempting to do so.

This is more of a "nice to have" than a real need since we're getting more tidbits throughout the repo. We can close and maybe circle back one day.

[joperezr]

I see, ok that makes sense. We don't need to close it, issues don't have to mean that it is a problem we need to fix right away, so it's fine to keep it open I just wanted to make sure that all of the documentation changes that we have been working on had not already covered this.

[krwq]

Marking as 3.0 for now since we should improve some docs until then but we may reiterate on that later as I'm not sure if we will be able to fully address all requests from this issue

[joperezr]

@shaggygi I'm finally back from my leave, and I know that you have made some changes in the past on our documentation, is the above list still accurate? (meaning that we haven't checked any of those boxes yet?)

[shaggygi]

@joperezr i think it is semi-accurate still. I’m thinking it might be better to approach this with slides instead of markdown. That would allow others to possibly show with different audiences. Since the API is still young and discussions are still trying to determine interfaces and such, I’d say this can wait until after. Maybe close and we can circle back later?

Good to hear you’re back. I’ve been (still am) out with an injury that’s hinder coding.

[joperezr]

I see, instead of closing I'll just flag it as future, so that we continue to track the work. Sad to hear about your injury, hope you get well soon!

[krwq]

@joperezr moving back to 3.0 since we closed the other issue. We should at min add How to start to move this to Future I think

[joperezr]

Sounds good to me.

[shaggygi]

Do you think this type of documentation should be in this repo or added under an 'IoT' section located with other .NET topics? If so, we might want to ping the docs team to possibly offer guidance on how we structure/document the different features/topics within System.Device.*.

[krwq]

I'd start wth README.md file and after we ship and APIs become stable then we should request docs team to have that.

[krwq]

We have just added PR and issue templates to improve state a bit. Please let us know if you think there should be more/less links/info (or even better send PR with changeset).