-
Notifications
You must be signed in to change notification settings - Fork 295
Add developer documentation #60
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
Conversation
This section of the PR description in #57 ("Monorepo") looks useful as reference.
|
176280c
to
843de34
Compare
Before this commit the main app serves as a proxy. After this commit the two workers talk directly to each other.
… spawnPHPWorkerThread
As I wrote these docs, many ideas stood out to me as overly complex. This PR got polluted with code refactoring, but so be it – there isn't much value in separating them at this point. I'll go ahead and merge even though this PR could use some polish. There is almost no documentation at the moment and even unpolished docs can onboard new contributors . Follow-up work:
|
Replaces #52
This PR aims to help new contributors get started by providing the necessary developer documentation. The proposed markdown file is a start but it needs more work before merging – feel free to jump in, comment, and update as you see fit.
The doc in this PR is all about the internal structure of this project. Documenting public-facing APIs doesn't make sense at this point as the project is still early, has no stable public API, and needs more contributors.
Related to #12
cc @dd32 @gziolo @StevenDufresne @eliot-akira