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

Merge documentation into monorepo #292

Open
ckartik opened this issue Jul 30, 2024 · 1 comment
Open

Merge documentation into monorepo #292

ckartik opened this issue Jul 30, 2024 · 1 comment

Comments

@ckartik
Copy link
Contributor

ckartik commented Jul 30, 2024

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.

@ckartik ckartik changed the title Merge Docs into monorepo Merge documentation into monorepo Jul 30, 2024
@shaspitz
Copy link
Contributor

shaspitz commented Aug 8, 2024

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

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

No branches or pull requests

2 participants