Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/instructions/module.instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
applyTo: "module/**"
---

## Module Overview

This module enables organizations and communities to deliver guides in multiple languages, support multiple versions, and manage several guides from a single platform.

It uses [Hugo](https://gohugo.io/) to generate a static site, which can be deployed anywhere (such as Azure Static Web Apps, Netlify, Vercel, GitHub Pages, or any static hosting provider).

### Translation Flexibility

- You can provide PDF-only translations for any guide or version, allowing for translated content even if a full web version is not available.
- Individual versions of a guide can be translated independently, without requiring other versions or other guides to be translated as well.
5 changes: 5 additions & 0 deletions .github/instructions/powershell.instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
applyTo: ".powershell/**"
---

These are demo powershell scripts for seting up the multi-lingual and other options for the Hugo sites that depend on this Module
Copy link

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a spelling error: 'seting' should be 'setting'.

Suggested change
These are demo powershell scripts for seting up the multi-lingual and other options for the Hugo sites that depend on this Module
These are demo powershell scripts for setting up the multi-lingual and other options for the Hugo sites that depend on this Module

Copilot uses AI. Check for mistakes.
7 changes: 7 additions & 0 deletions .github/instructions/site.instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
applyTo: "site/**"
---

## Site Overview

This site is a demo site in Hugo for the Hugo module, allowing local debugging and development. It loads content from other Hugo sites that depend on this module, making it easier to test and debug the module in a real-world context.
24 changes: 22 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
# Hugo Guides - Open Extension
# Hugo Guides Module

This repository provides an engine for guides in Hugo.
The **Hugo Guides Module** is designed to power a multi-language, multi-guide, multi-version platform for serving authoritative guides and resources. Its goal is to provide a flexible, scalable engine for publishing and maintaining guides such as:

- **The Kanban Guide**
- **Open Guide to Kanban**
- **Information for Decision Makers**
- **Scrum Expansion Pack**

This module enables organizations and communities to deliver guides in multiple languages, support multiple versions, and manage several guides from a single platform.

It uses [Hugo](https://gohugo.io/) to generate a static site, which can be deployed anywhere (such as Azure Static Web Apps, Netlify, Vercel, GitHub Pages, or any static hosting provider).

### Translation Flexibility

- You can provide PDF-only translations for any guide or version, allowing for translated content even if a full web version is not available.
- Individual versions of a guide can be translated independently, without requiring other versions or other guides to be translated as well.

## Current sites using this module

- [Kanban Guides](https://kanbanguides.org)[GitHub](https://github.com/KanbanGuides/KanbanGuides)
- [Scrum Expansion Pack](https://scrumexpansion.org)[GitHub](https://github.com/ScrumGuides/ScrumGuide-ExpansionPack)
- [Safe Delusion](https://safedelusion.com)
Copy link

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Safe Delusion entry appears incomplete - it's missing the GitHub link that the other entries have, and ends with just a dash.

Suggested change
- [Safe Delusion](https://safedelusion.com)
- [Safe Delusion](https://safedelusion.com)

Copilot uses AI. Check for mistakes.