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 directory layout #49

Open
norswap opened this issue Sep 27, 2023 · 0 comments
Open

Document directory layout #49

norswap opened this issue Sep 27, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation refactor
Milestone

Comments

@norswap
Copy link
Member

norswap commented Sep 27, 2023

Document the directory layout used by the repo.

This includes both directories we created ourselves + shenanigans done by the Optimism monorepo (cf. paths.py for details on that).

We could also consider moving some of the stuff created by operations in the monorepo out of it for better discoverability (having to browser to clones/optimism/packages/bedrock-contracts/deployments gets old pretty quickly).

Note that we can't manage these files entirely out of the monorepo because some of these paths are hardcoded in the logic, this is most notably the case in the deploy scripts (Deploy.s.sol etc).

This probably should be done as the last task of the big-refactor milestone.

@norswap norswap added the documentation Improvements or additions to documentation label Sep 27, 2023
@norswap norswap added this to the big-refactor milestone Dec 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation refactor
Projects
None yet
Development

No branches or pull requests

1 participant