Page URL
https://github.com/precice/precice.github.io/blob/master/_config.yml
What is wrong?
Bug Description
There is an inconsistent naming convention for the tutorial sidebar in _config.yml. The sidebar is referenced as tutorial_sidebar in the page defaults configuration, but listed as tutorials_sidebar in the sidebars declaration list.
Location
File: _config.yml
Expected Behavior
All references to the tutorial sidebar should use a consistent naming convention. Since the actual sidebar file is named tutorial_sidebar.yml (singular) and all page defaults use the singular form, the entry in the sidebars: list should be changed to tutorial_sidebar.
Proposed Fix
Change line 239 in _config.yml:
sidebars:
- home_sidebar
- docs_sidebar
-- tutorials_sidebar
+- tutorial_sidebar
- community_sidebar
Impact
While Jekyll may currently handle this without visible errors due to how the sidebar data files are loaded, this inconsistency:
- May cause confusion for new contributors
- Could lead to issues with sidebar validation or iteration
- Violates the principle of consistent naming conventions
Checklist
Page URL
https://github.com/precice/precice.github.io/blob/master/_config.yml
What is wrong?
Bug Description
There is an inconsistent naming convention for the tutorial sidebar in
_config.yml. The sidebar is referenced astutorial_sidebarin the page defaults configuration, but listed astutorials_sidebarin the sidebars declaration list.Location
File:
_config.ymlSingular usage (lines 98, 110):
Plural usage (line 239):
Expected Behavior
All references to the tutorial sidebar should use a consistent naming convention. Since the actual sidebar file is named
tutorial_sidebar.yml(singular) and all page defaults use the singular form, the entry in thesidebars:list should be changed totutorial_sidebar.Proposed Fix
Change line 239 in
_config.yml:Impact
While Jekyll may currently handle this without visible errors due to how the sidebar data files are loaded, this inconsistency:
Checklist
tutorial_sidebar.yml(nottutorials_sidebar.yml)_config.ymlto use singular formtutorials_sidebarexist in the codebase