Merged
Conversation
* Made doc fixes * Separation of dispatcher and consent config params --------- Authored-by: mandlamoyo <mandla.moyo@hotmail.com>
…ckkit into typed-events
… docs to highlight features
There was a problem hiding this comment.
Pull request overview
This PR improves Trackkit’s discoverability and shareability by enhancing SEO metadata and social previews across the VitePress docs site, and aligning the npm package metadata with the GitHub Pages docs URL.
Changes:
- Added page-level frontmatter (
title,description) across docs pages for better SEO/snippets. - Configured global SEO features in VitePress: sitemap, canonical URLs, OG/Twitter meta tags, and a social preview image + robots.txt.
- Updated Trackkit package metadata (keywords + homepage) and added docs theming overrides.
Reviewed changes
Copilot reviewed 39 out of 41 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/trackkit/package.json | Expanded npm keywords and updated homepage to GitHub Pages site. |
| docs/reference/providers.md | Added SEO frontmatter (title/description). |
| docs/reference/glossary.md | Added SEO frontmatter (title/description). |
| docs/reference/error-codes.md | Added SEO frontmatter (title/description). |
| docs/reference/configuration.md | Added SEO frontmatter (title/description). |
| docs/reference/api.md | Added SEO frontmatter (title/description). |
| docs/public/robots.txt | Added robots rules and sitemap URL for crawlers. |
| docs/public/og-image.png | Added Open Graph/Twitter share image asset. |
| docs/providers/umami.md | Added SEO frontmatter (title/description). |
| docs/providers/plausible.md | Added SEO frontmatter (title/description). |
| docs/providers/ga4.md | Added SEO frontmatter (title/description). |
| docs/overview/what-is-trackkit.md | Added SEO frontmatter (title/description). |
| docs/overview/quickstart.md | Added SEO frontmatter (title/description). |
| docs/overview/playground.md | Added SEO frontmatter (title/description). |
| docs/overview/faq.md | Added SEO frontmatter (title/description). |
| docs/overview/architecture.md | Added SEO frontmatter (title/description). |
| docs/migration/from-umami.md | Added SEO frontmatter (title/description). |
| docs/migration/from-plausible.md | Added SEO frontmatter (title/description). |
| docs/migration/from-ga4.md | Added SEO frontmatter (title/description). |
| docs/migration/from-env-vars.md | Added SEO frontmatter (title/description). |
| docs/index.md | Added homepage title/description frontmatter for SEO. |
| docs/guides/state-management.md | Added SEO frontmatter (title/description). |
| docs/guides/ssr.md | Added SEO frontmatter (title/description). |
| docs/guides/resilience-and-transports.md | Added SEO frontmatter (title/description). |
| docs/guides/queue-management.md | Added SEO frontmatter (title/description). |
| docs/guides/performance-tracking.md | Added SEO frontmatter (title/description). |
| docs/guides/navigation-autotrack.md | Added SEO frontmatter (title/description). |
| docs/guides/debugging-and-diagnostics.md | Added SEO frontmatter (title/description). |
| docs/guides/custom-providers.md | Added SEO frontmatter (title/description). |
| docs/guides/csp.md | Added SEO frontmatter (title/description). |
| docs/guides/consent-management.md | Added SEO frontmatter (title/description). |
| docs/guides/consent-and-privacy.md | Added SEO frontmatter (title/description). |
| docs/guides/connection-and-offline.md | Added SEO frontmatter (title/description). |
| docs/guides/choosing-provider.md | Added SEO frontmatter (title/description). |
| docs/examples/react-spa-umami.md | Added SEO frontmatter (title/description). |
| docs/examples/overview.md | Added SEO frontmatter (title/description). |
| docs/examples/next-ssr-ga4.md | Added SEO frontmatter (title/description). |
| docs/.vitepress/theme/index.ts | Imported the new custom theme CSS. |
| docs/.vitepress/theme/custom.css | Added brand color overrides (light/dark) for improved contrast and consistency. |
| docs/.vitepress/config.ts | Added sitemap, canonical URL injection, OG/Twitter tags, cleanUrls/lastUpdated, and title templating. |
| .gitignore | Ignored .content directory. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.