Add jekyll-sitemap plugin to Jekyll config

[OriNachum]

Add jekyll-sitemap plugin to the Jekyll _config.yml to automatically generate a sitemap.xml for the documentation site. This improves SEO by helping search engines discover and index all pages.

[qodo-code-review]

Review Summary by Qodo

Add jekyll-sitemap plugin to Jekyll configuration

✨ Enhancement

Walkthroughs

Description

• Adds jekyll-sitemap plugin to Jekyll configuration
• Automatically generates sitemap.xml for documentation site
• Improves SEO by helping search engines discover pages

Diagram

flowchart LR
  A["Jekyll Config"] -- "adds plugin" --> B["jekyll-sitemap"]
  B -- "generates" --> C["sitemap.xml"]
  C -- "improves" --> D["SEO Discovery"]

Loading

File Changes

1. _config.yml ⚙️ Configuration changes +1/-0

Add jekyll-sitemap plugin to plugins list

• Adds jekyll-sitemap to the plugins list
• Plugin positioned after jekyll-relative-links
• Enables automatic sitemap generation for documentation site

_config.yml

---

[qodo-code-review]

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0) 🎨 UX Issues (0)

1. Missing sitemap gem dependency ☑ 🐞 ☼

Description

_config.yml declares the jekyll-sitemap plugin, but the gem isn’t present in
Gemfile/Gemfile.lock, so Bundler won’t install it. The Pages build (bundle exec jekyll build)
will fail when Jekyll tries to load an uninstalled plugin.

Code

_config.yml[R23-26]

plugins:
  - jekyll-seo-tag
  - jekyll-relative-links
+    - jekyll-sitemap

Evidence

The repo’s Bundler dependencies include jekyll-seo-tag and jekyll-relative-links but not
jekyll-sitemap (neither in Gemfile nor Gemfile.lock). Since the Pages workflow uses
bundler-cache and runs bundle exec jekyll build, only gems in the lockfile are installed;
declaring a plugin without its gem will cause plugin loading to fail.

_config.yml[23-27]
Gemfile[1-6]
Gemfile.lock[57-85]
Gemfile.lock[170-175]
.github/workflows/pages.yml[24-41]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
`jekyll-sitemap` is configured as a plugin in `_config.yml` but is not included in Bundler dependencies, so the build will fail when Jekyll attempts to load the plugin.

### Issue Context
The GitHub Pages workflow uses `bundler-cache: true` and runs `bundle exec jekyll build`, which requires all configured plugins to be available as installed gems.

### Fix Focus Areas
- Gemfile[1-6]
- Gemfile.lock[170-175]
- _config.yml[23-27]

### Suggested change
1. Add the dependency:
```ruby
gem "jekyll-sitemap"
```
2. Run `bundle install` to update `Gemfile.lock`.
3. Ensure the `_config.yml` plugin entry is correctly indented as a peer list item.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

2. Broken plugins YAML list ☑ 🐞 ≡

Description

jekyll-sitemap is indented more than the other plugins items, which makes the YAML list invalid
(or mis-parsed as a nested list) and can prevent Jekyll from loading _config.yml. This will break
the Pages build when bundle exec jekyll build reads the config.

Code

_config.yml[R23-26]

plugins:
  - jekyll-seo-tag
  - jekyll-relative-links
+    - jekyll-sitemap

Evidence

In _config.yml, the new - jekyll-sitemap line is indented under the previous scalar list item
(jekyll-relative-links), which is not a valid sibling list item indentation. The Pages workflow
invokes bundle exec jekyll build, which parses _config.yml at startup, so a YAML parse/structure
error blocks the build.

_config.yml[23-27]
.github/workflows/pages.yml[24-41]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
`_config.yml` has an incorrectly indented `plugins` list item (`jekyll-sitemap`), which can make the YAML invalid or mis-structured.

### Issue Context
Jekyll reads `_config.yml` during `bundle exec jekyll build` (GitHub Pages workflow), so config parsing must be valid YAML.

### Fix Focus Areas
- _config.yml[23-27]

### Suggested change
Align the sitemap plugin with the other list items:
```yml
plugins:
 - jekyll-seo-tag
 - jekyll-relative-links
 - jekyll-sitemap
```

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

ⓘ The new review experience is currently in Beta. Learn more

[qodo-code-review]

2. Missing sitemap gem dependency 🐞 Bug ☼ Reliability

_config.yml declares the jekyll-sitemap plugin, but the gem isn’t present in
Gemfile/Gemfile.lock, so Bundler won’t install it. The Pages build (bundle exec jekyll build)
will fail when Jekyll tries to load an uninstalled plugin.

Agent Prompt

### Issue description
`jekyll-sitemap` is configured as a plugin in `_config.yml` but is not included in Bundler dependencies, so the build will fail when Jekyll attempts to load the plugin.

### Issue Context
The GitHub Pages workflow uses `bundler-cache: true` and runs `bundle exec jekyll build`, which requires all configured plugins to be available as installed gems.

### Fix Focus Areas
- Gemfile[1-6]
- Gemfile.lock[170-175]
- _config.yml[23-27]

### Suggested change
1. Add the dependency:
```ruby
gem "jekyll-sitemap"
```
2. Run `bundle install` to update `Gemfile.lock`.
3. Ensure the `_config.yml` plugin entry is correctly indented as a peer list item.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

[Copilot]

Pull request overview

Adds jekyll-sitemap to the documentation site’s Jekyll configuration so a sitemap.xml can be generated automatically for better SEO/discoverability.

Changes:

• Updates Jekyll plugins configuration to include jekyll-sitemap.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The new jekyll-sitemap entry is indented under jekyll-relative-links, which changes the YAML structure (nested list) and can cause Jekyll to ignore the plugin or fail parsing. Align jekyll-sitemap with the other plugin list items (same indentation as - jekyll-seo-tag). Also ensure the plugin is available to the build (e.g., add gem "jekyll-sitemap" to the Gemfile) so bundle exec jekyll build doesn’t fail.

Suggested change

	- jekyll-sitemap
	- jekyll-sitemap

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud