Docs need more examples and better Summary docs

[Armando-CodeCafe]

Alot of the docs on the gh-pages page feels very empty and lacking in some aspects, this made it difficult for me to learn the framework (thank god for good old gpt tho). There is multiple places in the docs (mostly in list of views) that dont explain things and force the user to just hope they can figure it out themselves. Most notibly alot of views still dont have example code, miss good summaries for the class/function declarations (which ofcourse mirrors in the intellisense xml docs).

Is there any plans to update the docs again with more example code (or atleast more deep dives into different views)?

Im also willing to contribute as this is one of my favorite frameworks to date.

[tznind]

Welcome aboard! we are in the middle of some pretty big architecture changes e.g.

• Fixes #3692++ - Rearchitects drivers #3837
• Fixes #3778: Decouples Command from KeyBindings #3880
• Fixes #3767 - Adds Ansi parser and scheduler. #3791
• Fixes #1265 - Adds Sixel rendering support #3734
• Create new ScrollBar based on a new Scroll and remove ScrollBarView/ScrollView #2489

So theres a lot of movement and a lot of doc rot. But more hands are always welcome!

V2 has kinda been a license to completely rewrite a lot of the foundation code. But it is going well and code coverage is good.

[Armando-CodeCafe]

Thats understandable haha. Any tips on how to help with documenting? i see docFX is used, so do i just add the docs in the code files themselves when i make a PR? if so, whats the best way to do that without conflicting with the actual code? or is there some way i can keep the documenting seperate from the source files?

[tznind]

The .md files in docfx/docs is where 'articles' go. The api docs themselves come from xmldoc comments

[tig]

Thats understandable haha. Any tips on how to help with documenting? i see docFX is used, so do i just add the docs in the code files themselves when i make a PR? if so, whats the best way to do that without conflicting with the actual code? or is there some way i can keep the documenting seperate from the source files?

It would be awesome if you were able to add more code samples to the docFx comments! Please do submit a PR.

Or, if you want to add some more sample code to the deep dive/conceptupual docs in ./docfx/docs that would be great too!