Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write technical documentation #707

Open
3 tasks
ISSOtm opened this issue Jan 20, 2021 · 2 comments
Open
3 tasks

Write technical documentation #707

ISSOtm opened this issue Jan 20, 2021 · 2 comments
Labels
docs This affects the documentation (web-specific issues go to rgbds-www) enhancement Typically new features; lesser priority than bugs

Comments

@ISSOtm
Copy link
Member

ISSOtm commented Jan 20, 2021

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:

  • What to put in there? (Organization)
  • Where to put it?
  • Do we want to archive old versions'?

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.

@ISSOtm ISSOtm added enhancement Typically new features; lesser priority than bugs docs This affects the documentation (web-specific issues go to rgbds-www) labels Jan 20, 2021
@Rangi42 Rangi42 added this to the v1.0.0 milestone Apr 25, 2021
@Rangi42
Copy link
Contributor

Rangi42 commented Mar 22, 2024

An ARCHITECTURE.md document explaining at a high level how each program is structured, would probably be very helpful for new contributors who don't know where to start.

@Rangi42 Rangi42 removed this from the v1.0.0 milestone Aug 6, 2024
@ISSOtm
Copy link
Member Author

ISSOtm commented Aug 6, 2024

I found this useful reading: https://matklad.github.io/2024/03/22/basic-things.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This affects the documentation (web-specific issues go to rgbds-www) enhancement Typically new features; lesser priority than bugs
Projects
None yet
Development

No branches or pull requests

2 participants