Add sitemap.xml for SEO optimization

[devleejb]

What this PR does / why we need it?

This PR adds a sitemap.xml to improve SEO for our project. By using Next.js, we leverage the next-sitemap package (https://www.npmjs.com/package/next-sitemap) to automatically generate the sitemap during the build process.

Additionally, a robots.txt file has also been automatically created to guide search engine crawlers.

Any background context you want to provide?

The addition of a sitemap helps search engines index our site more efficiently, improving visibility and search rankings. The generated files are intentionally added to .gitignore to keep the repository clean from automatically generated content.

If you require any changes to the options for the generated robots.txt or sitemap.xml, please let me know.

What are the relevant tickets?

Fixes #167

Checklist

• Added relevant tests or not required
• Didn't break anything

Summary by CodeRabbit

• New Features

  • Introduced sitemap generation capabilities for improved SEO.
  • Added configuration for robots.txt to guide search engine crawling.

• Chores

  • Updated repository management by ignoring autogenerated files (sitemap.xml and robots.txt).
  • Enhanced build and export processes to include sitemap generation.

[coderabbitai]

Walkthrough

The changes introduce a new configuration file for generating a sitemap and robots.txt for a Next.js application using the next-sitemap package. The .gitignore file is updated to exclude autogenerated files, and the package.json file is modified to integrate sitemap generation into the build and export processes.

Changes

Files	Change Summary
.gitignore	Added entries for sitemap.xml and robots.txt to ignore autogenerated files.
next-sitemap.config.js	Introduced a configuration file for next-sitemap, specifying siteUrl, enabling robots.txt generation, and disabling index sitemap creation.
package.json	Updated build and export scripts to include next-sitemap and added next-sitemap as a new dependency.

Assessment against linked issues

Objective	Addressed	Explanation
Add sitemap.xml for improved SEO (#167)	✅

🐇 Hop, hop, hooray, with sitemaps in play,
A path for the search bots, guiding their way.
With robots.txt, we set rules so bright,
Our Next.js site shines, a true SEO delight!
Let's bounce through the web, in joy we will sway! 🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between da10d22 and 8bf27bb.

Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

Files selected for processing (3)

• .gitignore (1 hunks)
• next-sitemap.config.js (1 hunks)
• package.json (2 hunks)

Files skipped from review due to trivial changes (2)

• .gitignore
• next-sitemap.config.js

Additional comments not posted (3)

package.json (3)

7-7: Review the updated build script.

The updated build script now includes next-sitemap to generate a sitemap post-build. This is a crucial step for SEO optimization. Ensure that next-sitemap is properly configured in your project to execute this command without issues.

---

8-8: Review the updated export script.

The export script has been modified to include sitemap generation before the export process. This ensures that the most recent changes are reflected in the sitemap, which is beneficial for SEO. Verify that the next-sitemap configuration supports this sequence of operations to avoid any build or export failures.

Consider verifying the sequence of operations by running a test build and export to ensure that the sitemap is correctly generated and no errors occur during the process.

---

28-28: Addition of next-sitemap dependency.

The addition of next-sitemap as a dependency is essential for the sitemap generation functionality. Ensure that the specified version ^4.2.3 is compatible with your current Next.js version and other project dependencies to avoid any compatibility issues.

It's recommended to verify the compatibility of next-sitemap with your current project setup, especially since Next.js and other dependencies can have specific version requirements that might affect the functionality of newly added packages.

[hackerwins]

Thanks for your contribution.