Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

[SUGGESTION] Docs - We need 'em #46

Open
byteduck opened this issue Feb 3, 2023 · 5 comments
Open

[SUGGESTION] Docs - We need 'em #46

byteduck opened this issue Feb 3, 2023 · 5 comments
Assignees
Labels
meta The issue is about duckOS or the project itself. suggestion New feature or request

Comments

@byteduck
Copy link
Owner

byteduck commented Feb 3, 2023

Suggestion

duckOS as a whole needs more documentation about how the kernel works, libraries, utilities, etc. I'm intimately familiar with how the whole thing works, but in order to make it easier on new contributors, it's probably a good idea for me to write some docs.

@byteduck byteduck added suggestion New feature or request meta The issue is about duckOS or the project itself. labels Feb 3, 2023
@byteduck byteduck self-assigned this Feb 4, 2023
@eliasoberholtz
Copy link

Yes please

@pawlos
Copy link
Contributor

pawlos commented Apr 11, 2023

@byteduck apart from the docs, I think it would be nice to have more info/warn being printed from the OS. Had some issues with loading PNGs and had to manually added those inside the loading logic to find out what's the problem (wrong format)

@byteduck
Copy link
Owner Author

@byteduck apart from the docs, I think it would be nice to have more info/warn being printed from the OS. Had some issues with loading PNGs and had to manually added those inside the loading logic to find out what's the problem (wrong format)

Agreed - a lot of that code was written very early on (before C++ was even used in userspace), so it doesn't make use of the logging utilities. I have been meaning to overhaul that stuff anyway, though.

@byteduck
Copy link
Owner Author

Anyway, as a whole, sorry progress has been so slow on this! I'm busy with school of course, and usually when I have time to work on duckOS I use it as an opportunity to write some code just for fun (because after all, who likes writing documentation)? It will get taken care of at some point, though.

@byteduck
Copy link
Owner Author

byteduck commented May 16, 2023

Just a quick update - I've added some new documentation on code style and common patterns in the docs folder. Generalized documentation on the workings of various components will come soon!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
meta The issue is about duckOS or the project itself. suggestion New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants