Skip to content
This repository has been archived by the owner on Nov 30, 2022. It is now read-only.

Dev-guide #11

Open
scrabsha opened this issue Jul 9, 2021 · 3 comments
Open

Dev-guide #11

scrabsha opened this issue Jul 9, 2021 · 3 comments

Comments

@scrabsha
Copy link
Contributor

scrabsha commented Jul 9, 2021

It would be a nice idea to have some documentation that describe briefly how things work. This would make contributions easier for newcomers.

@cbonaudo
Copy link
Member

cbonaudo commented Jul 9, 2021

Are you speaking about each mod specifically (eg: doc for git.rs, doc for glue.rs, etc...) ?

@scrabsha
Copy link
Contributor Author

scrabsha commented Jul 9, 2021

Yep! where each thing happen, how data flows between each pass, and so on.
Maybe we can take inspiration from Overview of the Compiler from the rustc dev guide.

@cbonaudo
Copy link
Member

Created in #15, with a brief summary.
now we can expand each part to describe accurately what is done

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

No branches or pull requests

2 participants