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.

Sign up for GitHub

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

Jump to bottom

[enhancement] Documentation #27

Open
zurgeg opened this issue Oct 20, 2023 · 2 comments
Open

[enhancement] Documentation #27

zurgeg opened this issue Oct 20, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@zurgeg
Copy link

zurgeg commented Oct 20, 2023

At the moment, there's no central documentation on the inner workings of PGL. I used to maintain a file with all of mine here although I have since stopped maintaining that. It would be good if we wrote all of our research down in a file, so future developers can know what's going on.
@kuroppoi kuroppoi added the documentation Improvements or additions to documentation label Oct 21, 2023
@kuroppoi
Copy link
Owner

Oof, one of my least favorite activities ;)
I think the code comments explain what's going on pretty well, but a dedicated wiki page or file isn't a bad idea.

@zurgeg
Copy link
Author

zurgeg commented Oct 21, 2023

Oof, one of my least favorite activities ;) I think the code comments explain what's going on pretty well, but a dedicated wiki page or file isn't a bad idea.

I'm with ya on that one :P

Yeah, I restarted the afformentioned documentation project which should work well enough for now at least

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@zurgeg @kuroppoi