Add jekyll-sitemap plugin to Jekyll config#7
Conversation
Review Summary by QodoAdd jekyll-sitemap plugin to Jekyll configuration
WalkthroughsDescription• Adds jekyll-sitemap plugin to Jekyll configuration • Automatically generates sitemap.xml for documentation site • Improves SEO by helping search engines discover pages Diagramflowchart LR
A["Jekyll Config"] -- "adds plugin" --> B["jekyll-sitemap"]
B -- "generates" --> C["sitemap.xml"]
C -- "improves" --> D["SEO"]
File Changes1. _config.yml
|
Code Review by Qodo
|
| plugins: | ||
| - jekyll-seo-tag | ||
| - jekyll-relative-links | ||
| - jekyll-sitemap |
There was a problem hiding this comment.
1. Invalid yaml indentation 🐞 Bug ≡ Correctness
jekyll-sitemap is indented as if it were nested under jekyll-relative-links, which makes _config.yml invalid YAML and prevents Jekyll from loading the config during build.
Agent Prompt
### Issue description
`_config.yml` has an incorrectly-indented `jekyll-sitemap` entry under `plugins`, making the YAML invalid.
### Issue Context
All plugin list items must be at the same indentation level under `plugins:`.
### Fix Focus Areas
- _config.yml[23-27]
### Suggested change
Ensure the line is aligned like 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
| plugins: | ||
| - jekyll-seo-tag | ||
| - jekyll-relative-links | ||
| - jekyll-sitemap |
There was a problem hiding this comment.
2. Missing sitemap gem dependency 🐞 Bug ☼ Reliability
_config.yml enables the jekyll-sitemap plugin, but the gem is not declared in Gemfile/Gemfile.lock, so bundle exec jekyll build in CI will fail when loading plugins.
Agent Prompt
### Issue description
`jekyll-sitemap` is configured as a Jekyll plugin but is not included in the Bundler dependencies, causing CI builds to fail.
### Issue Context
The GitHub Pages workflow runs `bundle exec jekyll build`, so all plugins listed in `_config.yml` must be present in `Gemfile` and locked in `Gemfile.lock`.
### Fix Focus Areas
- Gemfile[1-6]
- Gemfile.lock[170-175]
### Suggested change
1. Add to `Gemfile`:
```rb
gem "jekyll-sitemap"
```
2. Run `bundle install` and commit the updated `Gemfile.lock`.
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
There was a problem hiding this comment.
Pull request overview
Adds automatic sitemap generation for the Jekyll documentation site by enabling the jekyll-sitemap plugin in _config.yml, improving search engine discoverability.
Changes:
- Add
jekyll-sitemapto the Jekyllpluginslist in_config.yml.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| plugins: | ||
| - jekyll-seo-tag | ||
| - jekyll-relative-links | ||
| - jekyll-sitemap |
There was a problem hiding this comment.
jekyll-sitemap is indented as if it were nested under the previous list item, which makes the YAML invalid (or at least not a third plugin entry). It should be aligned with the other plugin entries under plugins:.
Also, jekyll-sitemap isn’t currently listed in the Gemfile, so builds that use Bundler will fail unless the gem is added (and lockfile updated) alongside this config change.
| - jekyll-sitemap | |
| - jekyll-sitemap |
Add
jekyll-sitemapplugin to the Jekyll_config.ymlto automatically generate a sitemap.xml for the documentation site. This improves SEO by helping search engines discover and index all pages.