feat: add sitemap.xml

[jasongitmail]

Closes #130

Summary by CodeRabbit

• New Features

  • Added a "Sitemap" section to the documentation for improved navigation and user experience.
  • Introduced a sitemap generation feature to enhance SEO and site navigation capabilities.

• Dependencies

  • Added super-sitemap library to improve sitemap management.

[coderabbitai]

Walkthrough

The changes introduce a sitemap feature to the project, enhancing its documentation and functionality. A new dependency, super-sitemap, is added to facilitate sitemap generation. A server-side handler is implemented to create a sitemap that excludes specific routes, particularly admin-related ones, ensuring a structured representation of the site's navigation.

Changes

File	Change Summary
README.md	Added a new section titled "Sitemap" to enhance documentation regarding project navigation.
package.json	Added super-sitemap dependency with version ^0.15.1 for sitemap generation capabilities.
src/routes/(marketing)/sitemap.xml/+server.ts	Implemented GET request handler to generate sitemap using super-sitemap, excluding admin routes.

Assessment against linked issues

Objective	Addressed	Explanation
Add sitemap (#[130])	✅
Include exclusion of admin routes (#[130])	✅

🐇 "In the garden where we play,
A sitemap blooms, bright as day.
With paths to hop and routes to see,
Our project grows, as sweet as can be!
So let’s rejoice, with hops and cheer,
A clearer map is finally here!" 🌼

---

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 fd7a963 and ded0034.

Files ignored due to path filters (1)

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

Files selected for processing (3)

• README.md (1 hunks)
• package.json (1 hunks)
• src/routes/(marketing)/sitemap.xml/+server.ts (1 hunks)

Files skipped from review due to trivial changes (1)

• README.md

Additional comments not posted (3)

src/routes/(marketing)/sitemap.xml/+server.ts (2)

1-3: LGTM!

The import statements are correct and necessary for the functionality of the file.

---

5-12: Improve error handling and remove redundant await keyword.

The GET request handler is correctly implemented, but there are a few improvements to consider:

• Add error handling to manage potential errors during sitemap generation.
• Remove the redundant await keyword in the return statement.

Apply this diff to improve the code:

-export const GET: RequestHandler = async () => {
-  return await sitemap.response({
-    origin: WebsiteBaseUrl,
-    excludeRoutePatterns: [
-      '.*\\(admin\\).*', // i.e. exclude routes within admin group
-    ],
-  });
+export const GET: RequestHandler = async () => {
+  try {
+    return sitemap.response({
+      origin: WebsiteBaseUrl,
+      excludeRoutePatterns: [
+        '.*\\(admin\\).*', // i.e. exclude routes within admin group
+      ],
+    });
+  } catch (error) {
+    console.error('Error generating sitemap:', error);
+    return new Response('Internal Server Error', { status: 500 });
+  }
};

package.json (1)

38-38: LGTM!

The added dependency super-sitemap is necessary for the functionality of the sitemap generation.

[scosman]

@jasongitmail Missing files? I fixed formatting errors but I'm getting build errors.

You can run the following locally to perform all the checks

npm run format_check
npm run lint
npm run build
npm run check
npm run test_run

[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 ded0034 and 44611f2.

Files selected for processing (1)

• src/routes/(marketing)/sitemap.xml/+server.ts (1 hunks)

Files skipped from review due to trivial changes (1)

• src/routes/(marketing)/sitemap.xml/+server.ts

[jasongitmail]

I pushed a commit for formatting. All checks passing on this PR.

Nope, not missing files. If there's a build error, it's most likely not super-sitemap related. But lmk what error you're seeing if any.

[scosman]

I just forgot to npm install 🤦. Will take a look!

[scosman]

@jasongitmail thanks!

[jasongitmail]

haha that happens! You're welcome 🙂