SEO: add unique meta tags, robots.txt & sitemap #246
Conversation
Signed-off-by: Yash Israni <[email protected]>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
✅ Deploy Preview for kmesh-net ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Summary of ChangesHello @yashisrani, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly boosts the Kmesh website's Search Engine Optimization (SEO) by implementing a holistic strategy. It introduces detailed meta descriptions and keywords for all documentation pages, establishes global SEO configurations within Docusaurus, and deploys standard Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces significant SEO improvements across the documentation site. It adds page-level metadata (description, keywords) to numerous markdown files, configures global SEO settings in docusaurus.config.js, and adds a robots.txt file. The changes are largely beneficial for search engine visibility. However, I've identified a few critical issues that need to be addressed: an incorrect favicon path, broken "Edit this page" links due to misconfigured editUrls, and the addition of a static sitemap.xml which overrides Docusaurus's superior auto-generation feature. Please see my detailed comments for suggestions on how to fix these issues.
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> | ||
| <url> | ||
| <loc>https://kmesh.net/</loc> | ||
| <lastmod>2025-06-20</lastmod> | ||
| <changefreq>weekly</changefreq> | ||
| <priority>1.0</priority> | ||
| </url> | ||
| <url> | ||
| <loc>https://kmesh.net/docs/welcome</loc> | ||
| <lastmod>2025-06-20</lastmod> | ||
| <changefreq>monthly</changefreq> | ||
| <priority>0.8</priority> | ||
| </url> | ||
| </urlset> No newline at end of file |
There was a problem hiding this comment.
This pull request adds a static sitemap.xml file. However, Docusaurus is already configured to automatically generate a comprehensive sitemap during the build process using @docusaurus/plugin-sitemap (which is enabled by default in the 'classic' preset and configured in docusaurus.config.js). A static sitemap is difficult to maintain and will quickly become outdated as new pages are added. This static file will override the auto-generated one, leading to most of the site's pages being excluded from the sitemap, which is detrimental to SEO. Please remove this static sitemap.xml file and let Docusaurus handle sitemap generation.
| docs: { | ||
| sidebarPath: "./sidebars.js", | ||
| editUrl: "https://github.com/kmesh-net/website/blob/main", | ||
| editUrl: "https://kmesh.net/docs/welcome", |
There was a problem hiding this comment.
The editUrl for docs has been changed to point to a page on the live site. This breaks the "Edit this page" functionality, which should link to the source file in the GitHub repository to allow users to propose changes. Please restore the link to the repository.
| editUrl: "https://kmesh.net/docs/welcome", | |
| editUrl: "https://github.com/kmesh-net/website/blob/main", |
| blog: { | ||
| showReadingTime: true, | ||
| feedOptions: { type: ["rss", "atom"], xslt: true }, | ||
| editUrl: "https://kmesh.net/blog", |
There was a problem hiding this comment.
The editUrl for blog has been changed to point to a page on the live site. This breaks the "Edit this page" functionality for blog posts. It should link to the source files in the GitHub repository.
| editUrl: "https://kmesh.net/blog", | |
| editUrl: "https://github.com/kmesh-net/website/blob/main", |
| favicon: "img/favicons/favicon.ico", | ||
| tagline: | ||
| "Kmesh is a high-performance service grid data plane software implemented based on the eBPF and programmable kernel.", | ||
| favicon: "/static/img/favicons/favicon.ico", |
There was a problem hiding this comment.
The path for the favicon is incorrect. For assets in the static directory, the path in the configuration should be relative to the static directory itself. The /static/ prefix is not needed and will likely cause the favicon to not be found (404 error). For consistency with other image paths in this file (like og:image and navbar.logo), please correct the path.
| favicon: "/static/img/favicons/favicon.ico", | |
| favicon: "/img/favicons/favicon.ico", |
yashisrani
changed the title
Description