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

feat: add readme to denoland #61

Merged
merged 2 commits into from
Jan 8, 2024
Merged

Conversation

WilliamBergamin
Copy link
Contributor

@WilliamBergamin WilliamBergamin commented Jan 8, 2024

Summary

This PR aim to allow denoland to display the readme.md from this repository while maintaining a single source of truth for the readme

Testing

Test this out from this branch

Special notes

This change moves the README.md content to src/README.md and creates a symbolic link between README.md and src/README.md, this makes src/README.md the source of truth but allows GitHub to properly render the README.md file

Feedback

  • Is this something we want to implement?
  • Is there a simpler way to do this?
  • Could this cause confusion in the future?

Requirements

@WilliamBergamin WilliamBergamin added the documentation Improvements or additions to documentation label Jan 8, 2024
@WilliamBergamin WilliamBergamin self-assigned this Jan 8, 2024
@WilliamBergamin WilliamBergamin requested a review from a team as a code owner January 8, 2024 17:08
Copy link

codecov bot commented Jan 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (b20176a) 95.09% compared to head (5c53ae8) 95.09%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #61   +/-   ##
=======================================
  Coverage   95.09%   95.09%           
=======================================
  Files          14       14           
  Lines         550      550           
  Branches       82       82           
=======================================
  Hits          523      523           
  Misses         27       27           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@WilliamBergamin WilliamBergamin merged commit f78fa50 into main Jan 8, 2024
4 checks passed
@WilliamBergamin WilliamBergamin deleted the add-readme-to-denoland branch January 8, 2024 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants