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

Wrong information in docs README file #3004

Closed
FatumaA opened this issue Mar 27, 2024 · 4 comments · Fixed by #3092
Closed

Wrong information in docs README file #3004

FatumaA opened this issue Mar 27, 2024 · 4 comments · Fixed by #3092
Labels
Docs Changes related to the documentation

Comments

@FatumaA
Copy link
Contributor

FatumaA commented Mar 27, 2024

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

  1. Go into the docs folder from within the Undici project structure
  2. Open the README file in the docs folder
  3. Notice it does not give any specific docs related information and it is a replica of the README at the root of the project

Expected Behavior

  1. The README in the docs folder should hold information on how to run the docs locally

Logs & Screenshots

Group 11

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.

@FatumaA FatumaA added the bug Something isn't working label Mar 27, 2024
@Uzlopak Uzlopak added Docs Changes related to the documentation and removed bug Something isn't working labels Mar 27, 2024
@mcollina
Copy link
Member

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.

@FatumaA
Copy link
Contributor Author

FatumaA commented Mar 31, 2024

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?

@mcollina
Copy link
Member

Sure thing, that works.

@FatumaA
Copy link
Contributor Author

FatumaA commented Mar 31, 2024

On it then, thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Changes related to the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants