Skip to content

docs: adopt portable documentation governance - #50

Merged
hindermath merged 7 commits into
mainfrom
codex/feature-023-doc-architecture-adoption
Aug 1, 2026
Merged

docs: adopt portable documentation governance#50
hindermath merged 7 commits into
mainfrom
codex/feature-023-doc-architecture-adoption

Conversation

@hindermath

Copy link
Copy Markdown
Owner

Summary

  • add portable reader-path and progressive-disclosure guidance
  • require repository-specific source, runtime, deployment and distribution decisions
  • record target-local Documentation Impact evidence and refresh generated statistics

Scope

Documentation only. Product, runtime, API, dependency, package, workflow and toolchain behavior remain unchanged.

Validation

  • Documentation Impact validator: Bash and PowerShell PASS
  • Documentation Impact fixtures: Bash and PowerShell PASS
  • git diff check: PASS
  • statistics renderer/check: PASS
  • Homogeneity: PASS

Documentation Impact

UpdateRequired; source and owner: repository docs/documentation-governance.md and Repository Maintainer; audiences: learners, users, maintainers/AI agents and reviewers; language: German first/English second; distribution: repository source; Home sync: no; re-evaluate when reader paths or the repository source/runtime contract changes.

Part of Home Baseline Feature 023 fleet adoption.

Copilot AI review requested due to automatic review settings August 1, 2026 21:47

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adopts the portable documentation governance approach for this repository by expanding the documentation-governance contract (reader paths, progressive disclosure, and repository-specific source/distribution decisions), adding Documentation Impact evidence for feature 023, and refreshing the generated project statistics snapshot.

Changes:

  • Extend docs/documentation-governance.md with reader-path + progressive-disclosure guidance and explicit source/distribution terminology.
  • Add docs/documentation-impact/feature-023-documentation-architecture-adoption.json as Documentation Impact evidence for feature 023.
  • Refresh docs/project-statistics.md (window end date, counts, and derived charts/text alternatives).

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
docs/project-statistics.md Updates the generated statistics window and derived KPIs/charts.
docs/documentation-impact/feature-023-documentation-architecture-adoption.json Adds Documentation Impact evidence entry for feature 023 governance adoption.
docs/documentation-governance.md Adds portable reader-path/progressive-disclosure guidance and clarifies source/distribution decisions.

Comment thread docs/project-statistics.md
Copilot AI review requested due to automatic review settings August 1, 2026 21:55

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

Suppressed comments (2)

docs/project-statistics.md:624

  • The month breakdown includes a partial month for 2026-08, but there is no entry for 2025-08 even though the window starts in August 2025 (2025-08-10). Either include the starting partial month (2025-08) or avoid partial-month rows (remove 2026-08) so the table matches the stated window boundaries.
| Monat / Month | Geaenderte Textzeilen / Changed text lines |
|---|---:|
| 2025-09 | 633 |
| 2025-10 | 1992 |
| 2025-11 | 102936 |

docs/project-statistics.md:495

  • The weekly blocks use an end date of 2026-08-08, which contradicts the stated observable period end (2026-08-02) and also extends further into the future. Please align the week-range captions with the chosen observable period (or explicitly document that the visualization always pads to full weeks and ensure the main period reflects that).
Wochen / Weeks 27..52 | 2026-02-08..2026-08-08
So/Su  0 0 0 0 4 0 4 0 0 2 4 0 0 0 0 0 1 0 4 0 0 0 1 4 3 0
Mo/Mo  0 0 0 0 0 0 0 2 0 1 4 0 4 0 0 0 0 0 0 0 3 1 4 4 0 -
Di/Tu  0 0 0 0 2 0 0 3 0 0 0 0 3 0 0 3 0 0 0 0 2 0 3 4 4 -

Copilot AI review requested due to automatic review settings August 1, 2026 22:13

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

Suppressed comments (2)

docs/project-statistics.md:461

  • The "Observable period" ends on 2026-08-02, but the weekly grids below run through 2026-08-08 and use "- = noch nicht abgelaufen". Without an explicit note, this looks like an inconsistency in the reporting window and can confuse readers who reconcile the ranges.
| Methodik / Methodology | v2; source `fc865a7d1135` |

docs/documentation-impact/feature-023-documentation-architecture-adoption.json:32

  • The evidence uses "distributionClass": "sourceOnly". In docs/documentation-governance.md, sourceOnly is described as a Home Baseline / Level-0 specific distribution class (read from the Level-0 source), so using it here can be misread as Level-0 semantics. Consider using a repository-specific value that matches the PR's stated distribution (repository source).
      "distributionClass": "sourceOnly",

@hindermath
hindermath merged commit 4a43cc3 into main Aug 1, 2026
30 checks passed
@hindermath
hindermath deleted the codex/feature-023-doc-architecture-adoption branch August 1, 2026 22:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants