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

Document the system design and components #4114

Closed
asarkar opened this issue Dec 12, 2024 · 2 comments · Fixed by #4156
Closed

Document the system design and components #4114

asarkar opened this issue Dec 12, 2024 · 2 comments · Fixed by #4156
Milestone

Comments

@asarkar
Copy link

asarkar commented Dec 12, 2024

The mill documentation is mainly from a user's point-of-view, i.e. how to use the tool. I'd like to see a breakdown of the design that is now all in the maintainers' heads in the form of tribal knowledge. For example, what are the main concepts/classes like T, Task, etc., how are these related, what are the build components and their relationships, especially now that multi-file builds are supported. For example, here's an example of Gradle Build Lifecycle. There's also Gradle API for developers.

Having such documentation would tremendously encourage people to make new contributions, since they would have a place to start, and not have to drudge through the codebase just to make simple changes.

I hope the ticket makes sense; let me know if you need more clarification/information.

@lihaoyi
Copy link
Member

lihaoyi commented Dec 12, 2024

https://mill-build.org/mill/main-branch/depth/evaluation-model.html and https://mill-build.org/mill/main-branch/depth/design-principles.html are meant to cover these topics, but they can definitely be fleshed out. Will leave this ticket open until I have time to give that part of the docs an overhaul

lihaoyi added a commit that referenced this issue Dec 18, 2024
Renovated it to freshen it up: diagrams, cross-links, and general
cleanup. Also renamed it `The Mill Execution Model` to avoid confusion
with the `Evaluation` phase in Mill

Fixes #4114
@lefou lefou added this to the 0.12.5 milestone Dec 18, 2024
@lihaoyi
Copy link
Member

lihaoyi commented Dec 18, 2024

I wrote up a new set of docs about The Mill Execution Model (https://mill-build.org/mill/main-branch/depth/execution-model.html) and THe Mill Process Architecture (https://mill-build.org/mill/main-branch/depth/process-architecture.html). They won't be in the main docs until next release, but until then feel free to take a look at them in the pre-release main-branch

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants