Skip to content

Commit 2b7903f

Browse files
authored
Update docs (#333)
This pull request introduces significant improvements to the documentation and configuration of the Scrum Guide Expansion Pack project. The main focus is on clarifying the site's architecture, restructuring content around a versioned guides model, and marking legacy content for backward compatibility. Updates also include enhanced guidance for AI assistants and improved documentation of the Hugo module-based template system. **Key changes include:** --- ### Content Architecture and Structure * Refactored documentation (`docs/architecture.md`, `docs/content-management.md`) to describe a **versioned guides model**: each guide (core or extension) is a self-contained, version-controlled document supporting multiple languages and independent updates. Legacy creator content is now explicitly marked and separated. [[1]](diffhunk://#diff-140eef3ba41bdcf401d507408084181f2c0ac627532b61e0f7906ea7cc926782L51-R95) [[2]](diffhunk://#diff-140eef3ba41bdcf401d507408084181f2c0ac627532b61e0f7906ea7cc926782R112-R202) [[3]](diffhunk://#diff-2ac4893aa0491d153ceea4eea80736120d2b356f801faf00ccd79151f38b9758L7-R109) * Updated content structure examples and explanations to reflect the new organization, emphasizing core and extension guides, versioning, translation directories, and legacy content. --- ### Legacy Content and Backward Compatibility * Marked the `creators/` section and related navigation/menu items as **LEGACY** throughout configuration and documentation, clarifying its backward compatibility status and that it is no longer actively maintained. [[1]](diffhunk://#diff-17ed18489a956f326ec0fe4040850c5bc9261d4631fb42da4c52891d74a59180L60-R60) [[2]](diffhunk://#diff-17ed18489a956f326ec0fe4040850c5bc9261d4631fb42da4c52891d74a59180L228-R228) [[3]](diffhunk://#diff-17ed18489a956f326ec0fe4040850c5bc9261d4631fb42da4c52891d74a59180L360-R360) [[4]](diffhunk://#diff-3d36a1bf06148bc6ba1ce2ed3d19de32ea708d955fed212c0d27c536f0bd4da7L27-R51) --- ### Hugo Module and Template Management * Expanded documentation to explain the use of the **Hugo Module system** for template management, where base templates are imported from an external module (`github.com/nkdAgility/HugoGuides/module`), and local templates are only overrides or site-specific. * Updated the site architecture documentation to show the new layouts and template hierarchy under the Hugo module approach. --- ### AI Assistant Guidance * Added explicit guidance and links for AI assistants in the project documentation (`docs/README.md`), directing them to a dedicated agent guide for working with the codebase. --- ### Workflow and Codeowners Updates * Updated `.github/CODEOWNERS` to reflect the new content structure, assigning owners to new extension guide directories and clarifying ownership for legacy and new sections. * Added warnings and comments to the Azure Static Web Apps workflow file, marking it as deprecated and not to be edited or enabled. * Minor formatting and consistency changes in workflow YAML files. These changes collectively modernize the project's documentation and configuration, making the structure clearer for contributors, maintainers, and automated tools.
2 parents 29c3a94 + 816b8bc commit 2b7903f

15 files changed

+1865
-576
lines changed

.github/CODEOWNERS

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
# Remove default ownership for /site/content/ (will be handled by specific rules below)
66

7-
/site/content/
7+
/site/content/
88

99
# Technical and configuration files
1010

@@ -24,18 +24,31 @@ LICENSE @mrhinsh
2424

2525
\*.md @ViralGoodAgile @rjocham
2626

27-
# Site content - specific areas
28-
29-
/site/content/guide/ @jeffsutherland @ViralGoodAgile @rjocham
30-
/site/content/creators/jeff-sutherland/ @jeffsutherland
31-
/site/content/creators/john-coleman/ @ViralGoodAgile
32-
/site/content/creators/ralph-jocham/ @rjocham
27+
# Site content - Extensions (by creator)
28+
29+
/site/content/adaptive-enterprise/ @ViralGoodAgile @rjocham
30+
/site/content/adaptive-executive/ @ViralGoodAgile @rjocham
31+
/site/content/ai-and-scrum/ @rjocham @jeffsutherland
32+
/site/content/complexity/ @ViralGoodAgile @rjocham
33+
/site/content/emergent-strategy-and-depoyment/ @Tom-Gilb
34+
/site/content/holistic-testing/ @lisacrispin
35+
/site/content/multi-team-scrum/ @ViralGoodAgile @rjocham @jeffsutherland
36+
/site/content/operating-models/ @mrhinsh
37+
/site/content/planguage/ @Tom-Gilb
38+
/site/content/product-thinking/ @rjocham @Magdalena-Firlit
39+
/site/content/psychological-safety-in-scrum-teams/ @JotPePL
40+
/site/content/scrum-guide-expanded/ @ViralGoodAgile @rjocham @jeffsutherland
41+
/site/content/scrum-on-one-page/ @ViralGoodAgile @rjocham
42+
/site/content/software-engineering-practices/
43+
/site/content/strategy-as-an-empirical-capability/ @kjscotland
3344

3445
# Site content - general areas
3546

36-
/site/content/download/ @mrhinsh
3747
/site/content/\_index.md @ViralGoodAgile @rjocham
38-
/site/content/creators/\_index.md @ViralGoodAgile @rjocham
48+
/site/content/creators/ @ViralGoodAgile @rjocham
49+
/site/content/creators/jeff-sutherland/ @jeffsutherland
50+
/site/content/creators/john-coleman/ @ViralGoodAgile
51+
/site/content/creators/ralph-jocham/ @rjocham
3952

4053
# Hugo theme and layout files
4154

0 commit comments

Comments
 (0)