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: split between utility types and metadata values types #992

Conversation

davidlj95
Copy link
Owner

Issue or need

In built-in modules docs, the only type reference is to the type helping to set metadata values JSON. However, there's another interesting type to see all the metadata a provider can set. Which is the same without the Metadata suffix. Reaching this one requires clicking in the Metadata one and then clicking into the type. Which can be confusing as insdide the XMetadata type there is the x property and the X type. So easy to click the not useful one.

Proposed changes

Add reference to both types. Specify which one is the utility one and which one allows to see all metadata values that can be set for a provider.

Replace module / providers with just providers as providers API is recommended.

Quick reminders

  • 🤝 I will follow Code of Conduct
  • No existing pull request already does almost same changes
  • 👁️ Contributing docs are something I've taken a look at
  • 📝 Commit messages convention has been followed
  • 💬 TSDoc comments have been added or updated indicating API visibility if API surface has changed.
  • 🧪 Tests have been added if needed. For instance, if adding new features or fixing a bug. Or removed if removing features.
  • ⚙️ API Report has been updated if API surface is altered.

@davidlj95 davidlj95 enabled auto-merge (squash) October 24, 2024 11:37
Copy link
Owner Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @davidlj95 and the rest of your teammates on Graphite Graphite

Copy link

📦 Bundle size (Angular v15)

Git ref: f482ad8c998bccf37830a9d7a2fd731432205baa

Module file Size Base size Difference
ngx-meta-core.mjs 3384 bytes (3.4KiB) 3384 bytes (3.4KiB) No change
ngx-meta-json-ld.mjs 206 bytes (206B) 206 bytes (206B) No change
ngx-meta-open-graph.mjs 870 bytes (870B) 870 bytes (870B) No change
ngx-meta-routing.mjs 373 bytes (373B) 373 bytes (373B) No change
ngx-meta-standard.mjs 808 bytes (808B) 808 bytes (808B) No change
ngx-meta-twitter-card.mjs 448 bytes (448B) 448 bytes (448B) No change
Total 6089 bytes (6.0KiB) 6089 bytes (6.0KiB) No change

Copy link

📦 Bundle size (Angular v18)

Git ref: f482ad8c998bccf37830a9d7a2fd731432205baa

Module file Size Base size Difference
ngx-meta-core.mjs 3205 bytes (3.2KiB) 3205 bytes (3.2KiB) No change
ngx-meta-json-ld.mjs 217 bytes (217B) 217 bytes (217B) No change
ngx-meta-open-graph.mjs 931 bytes (931B) 931 bytes (931B) No change
ngx-meta-routing.mjs 394 bytes (394B) 394 bytes (394B) No change
ngx-meta-standard.mjs 857 bytes (857B) 857 bytes (857B) No change
ngx-meta-twitter-card.mjs 487 bytes (487B) 487 bytes (487B) No change
Total 6091 bytes (6.0KiB) 6091 bytes (6.0KiB) No change

Copy link

📦 Bundle size (Angular v16)

Git ref: f482ad8c998bccf37830a9d7a2fd731432205baa

Module file Size Base size Difference
ngx-meta-core.mjs 3467 bytes (3.4KiB) 3467 bytes (3.4KiB) No change
ngx-meta-json-ld.mjs 201 bytes (201B) 201 bytes (201B) No change
ngx-meta-open-graph.mjs 870 bytes (870B) 870 bytes (870B) No change
ngx-meta-routing.mjs 379 bytes (379B) 379 bytes (379B) No change
ngx-meta-standard.mjs 808 bytes (808B) 808 bytes (808B) No change
ngx-meta-twitter-card.mjs 448 bytes (448B) 448 bytes (448B) No change
Total 6173 bytes (6.1KiB) 6173 bytes (6.1KiB) No change

Copy link

📦 Bundle size (Angular v17)

Git ref: f482ad8c998bccf37830a9d7a2fd731432205baa

Module file Size Base size Difference
ngx-meta-core.mjs 3205 bytes (3.2KiB) 3205 bytes (3.2KiB) No change
ngx-meta-json-ld.mjs 217 bytes (217B) 217 bytes (217B) No change
ngx-meta-open-graph.mjs 931 bytes (931B) 931 bytes (931B) No change
ngx-meta-routing.mjs 394 bytes (394B) 394 bytes (394B) No change
ngx-meta-standard.mjs 857 bytes (857B) 857 bytes (857B) No change
ngx-meta-twitter-card.mjs 487 bytes (487B) 487 bytes (487B) No change
Total 6091 bytes (6.0KiB) 6091 bytes (6.0KiB) No change

Copy link

codecov bot commented Oct 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (5f4c2c3) to head (f482ad8).
Report is 33 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #992   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           89        89           
  Lines          395       395           
  Branches        55        55           
=========================================
  Hits           395       395           

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

@davidlj95 davidlj95 merged commit 994d707 into main Oct 24, 2024
35 checks passed
@davidlj95 davidlj95 deleted the stacked/docs-split-between-utility-types-and-metadata-values-types branch October 24, 2024 11:43
Copy link

🎉 This PR is included in version 1.0.0-beta.32 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

1 participant