Commit 2b7903f
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.File tree
15 files changed
+1865
-576
lines changed- .github
- workflows
- docs
15 files changed
+1865
-576
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
27 | | - | |
28 | | - | |
29 | | - | |
30 | | - | |
31 | | - | |
32 | | - | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
33 | 44 | | |
34 | 45 | | |
35 | 46 | | |
36 | | - | |
37 | 47 | | |
38 | | - | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
39 | 52 | | |
40 | 53 | | |
41 | 54 | | |
| |||
0 commit comments