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

docs: add package pronunciation #569

Merged
merged 2 commits into from
Nov 20, 2023
Merged

docs: add package pronunciation #569

merged 2 commits into from
Nov 20, 2023

Conversation

nozomuikuta
Copy link
Member

πŸ”— Linked issue

No related issues in this repository.

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

This PR is created based on unjs/website#168 (comment).
Pronunciation symbols are copied from Cambridge Dictionary:

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@nozomuikuta nozomuikuta self-assigned this Nov 4, 2023
@nozomuikuta nozomuikuta changed the title Chore/add pronunciation docs: add package pronunciation Nov 4, 2023
Copy link

codecov bot commented Nov 4, 2023

Codecov Report

Merging #569 (41f3109) into main (b7aca96) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #569   +/-   ##
=======================================
  Coverage   83.83%   83.83%           
=======================================
  Files          31       31           
  Lines        3563     3563           
  Branches      543      543           
=======================================
  Hits         2987     2987           
  Misses        576      576           

@@ -7,7 +7,7 @@
[![License][license-src]][license-href]
[![JSDocs][jsdocs-src]][jsdocs-href]

H3 is a minimal h(ttp) framework built for high performance and portability.
H3 (pronounced as /eΙͺtΚƒΞΈriː/, like h-3) is a minimal h(ttp) framework built for high performance and portability.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some packages' READMEs don't have introduction sentence like this: for example, c12's README just says "Smart Configuration Loader.".

So, we might want to get all REAMEs to have an introduction sentence like "c12 (pronounced as /.../, like c-twelve) is a ...".

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes!

@nozomuikuta
Copy link
Member Author

@pi0

How does this PR look to you? πŸ‘€
If you are fine, @Barbapapazes and I would be able to work on other repositories.

@pi0
Copy link
Member

pi0 commented Nov 20, 2023

Thanks!

@pi0 pi0 merged commit ee17086 into main Nov 20, 2023
6 checks passed
@pi0 pi0 deleted the chore/add-pronunciation branch November 20, 2023 02:27
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

Successfully merging this pull request may close these issues.

3 participants