-
Notifications
You must be signed in to change notification settings - Fork 570
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
Wrong information in docs README file #3004
Comments
The README in the docs folder is what get's published in our website, so we can't change that. Maybe we should include how to visualize the docs in the CONTRIBUTING.md file. |
Yeah we can put the necesssry info (how the codebase is structured, how to run the different sections of the app) in the main contributing guide. Or we can add contributing guides to the say benchmarks and docs and have the main contributing guide link to them. What are your thoughts? |
Sure thing, that works. |
On it then, thanks |
Bug Description
The README file in the docs folder appears to be a replica of the README in the root of the project. It does not offer any information on how to run the docs locally.
Reproducible By
Expected Behavior
Logs & Screenshots
Environment
Additional context
It appears that the codebase is a Monorepo with the benchmarks and docs being their own separate projects within the main one. I think the contributing guide should be updated to reflect this and it should also show clearly the general architecture of the project so contributors can know where to go to run specific parts.
Perhaps the benchmarks folder should have it's own README?
I would like to raise the PR for this issue. And I'd be happy to create the other issues if it makes sense.
The text was updated successfully, but these errors were encountered: