primev/mev-commit

Merge documentation into monorepo

ckartik opened this issue · 1 comments

Given our emphasis on the monorepo, having documentation in the mev-commit repo would allow us to modify the documentation along with feature implementation and modification. A strategy will be needed to ensure that docs don't reflect features sets that are yet to be released. We can follow an approach that ensures we tag documentation that is net new with to be released tags, and in the release process, remove these tags.

Given the fast moving development, this will support tight correlation between the docs and mev-commit stack, and remove need for redundant operations function focused on aligning documentation.

Sounds like a great idea, we'll likely want to setup our docs frontend to have a dropdown where you can toggle between docs relevant to each release