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.

Sign up for GitHub

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

Jump to bottom

[project] Duplicate the libs/movex/Readme.md at root #137

Closed
GabrielCTroia opened this issue Oct 14, 2023 · 3 comments
Closed

[project] Duplicate the libs/movex/Readme.md at root #137

GabrielCTroia opened this issue Oct 14, 2023 · 3 comments
Assignees
@jude-san
Labels
good first issue Good for newcomers hacktoberfest Improvements that qualify for Hacktoberfest

Comments

@GabrielCTroia
Copy link
Contributor

GabrielCTroia commented Oct 14, 2023 •
edited
Loading

Context

Currently the readme for the whole repo is actually living at libs/movex/README.md and it has a symlink referencing it at root level /README.md to keep things DRY .

This made sense in the past but no longer now, because the 2 READMEs will now serve different purposes.

The / Readme will represent the whole project, while the libs/movex one will only describe the movex npm library.

What

Remove the symlink and make an actual real copy of the movex/readme into root.

Definition of done

  • the symlink is gone and the root readme will be an actual hard copy of the movex readme (for now)
@GabrielCTroia GabrielCTroia changed the title [project] Move the Readme to root [project] Duplicate the libs/movex/Readme.md at root Oct 14, 2023
@GabrielCTroia GabrielCTroia added good first issue Good for newcomers hacktoberfest Improvements that qualify for Hacktoberfest labels Oct 14, 2023
@jude-san
Copy link
Contributor

Hi @GabrielCTroia can I take this one?

@GabrielCTroia
Copy link
Contributor Author

Than kyou @jude-san, I just assigned it to you!

@jude-san
Copy link
Contributor

thanks

GabrielCTroia added a commit that referenced this issue Oct 21, 2023
@GabrielCTroia
Merge pull request #171 from jude-san/readmeupdate
ca48494 
Fix [project] Duplicate the libsmovexReadme.md at root #137
@GabrielCTroia GabrielCTroia mentioned this issue Oct 21, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jude-san jude-san

Labels
good first issue Good for newcomers hacktoberfest Improvements that qualify for Hacktoberfest
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@GabrielCTroia @jude-san