Write technical documentation #707
Labels
docs
This affects the documentation (web-specific issues go to rgbds-www)
enhancement
Typically new features; lesser priority than bugs
A large part, I believe, of why RGBDS maintainership is not user-friendly, is the lack of technical documentation. The codebase has a lot of implied conventions, organization, and behavior, which are definitely not clear at first glance.
Questions:
For the organization, I think explaining the build systems (and why there are two) as well as the tree hierarchy should be fairly low-hanging but nonetheless useful fruit. I think we should also document some decisions that were taken, and their rationale. Currently, those were decided largely on Discord, and some in GitHub issues, but neither is a good archive, especially the former.
For the location, I think a dedicated folder on our website should do the trick. I wouldn't make it a sub-folder of
/docs/
, though, but a dedicated folder.The text was updated successfully, but these errors were encountered: