Skip to content

docs: support nested directories in extensions#887

Merged
vbreuss merged 2 commits intomainfrom
topic/update-pages
Jan 31, 2026
Merged

docs: support nested directories in extensions#887
vbreuss merged 2 commits intomainfrom
topic/update-pages

Conversation

@vbreuss
Copy link
Copy Markdown
Member

@vbreuss vbreuss commented Jan 31, 2026

This PR updates the documentation build pipeline to support nested directory structures when fetching extension documentation from GitHub. Previously, the pipeline only handled flat file structures; now it recursively processes directories.

Key Changes:

  • Extracted file download logic into a recursive helper method
  • Added support for detecting and processing directory structures from GitHub API responses
  • Updated docusaurus dependencies

@vbreuss vbreuss self-assigned this Jan 31, 2026
@vbreuss vbreuss added the documentation Improvements or additions to documentation label Jan 31, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 31, 2026

🚀 Benchmark Results

Details

BenchmarkDotNet v0.15.8, Linux Ubuntu 24.04.3 LTS (Noble Numbat)
AMD EPYC 7763 2.45GHz, 1 CPU, 4 logical and 2 physical cores
.NET SDK 10.0.102
[Host] : .NET 8.0.23 (8.0.23, 8.0.2325.60607), X64 RyuJIT x86-64-v3

Job=InProcess Toolchain=InProcessEmitToolchain IterationCount=15
LaunchCount=1 WarmupCount=10

Method Mean Error StdDev Gen0 Gen1 Allocated
Bool_aweXpect 272.4 ns 3.55 ns 3.15 ns 0.0415 - 696 B
Bool_FluentAssertions 261.6 ns 2.66 ns 2.22 ns 0.0567 - 952 B
Equivalency_aweXpect 318,723.1 ns 1,009.87 ns 843.29 ns 20.0195 0.4883 335444 B
Equivalency_FluentAssertions 2,801,243.5 ns 11,305.47 ns 10,575.15 ns 285.1563 46.8750 4804906 B
Int_GreaterThan_aweXpect 264.1 ns 2.53 ns 1.97 ns 0.0482 - 808 B
Int_GreaterThan_FluentAssertions 275.9 ns 4.87 ns 4.55 ns 0.0730 - 1224 B
ItemsCount_AtLeast_aweXpect 516.3 ns 6.86 ns 6.42 ns 0.0811 - 1360 B
ItemsCount_AtLeast_FluentAssertions 537.4 ns 13.65 ns 12.76 ns 0.1192 - 2008 B
String_aweXpect 481.5 ns 2.92 ns 2.74 ns 0.0668 - 1128 B
String_FluentAssertions 1,273.3 ns 7.37 ns 6.53 ns 0.2346 - 3944 B
StringArray_aweXpect 1,980.1 ns 4.03 ns 3.57 ns 0.1564 - 2624 B
StringArray_FluentAssertions 1,510.8 ns 19.27 ns 17.08 ns 0.2480 - 4152 B
StringArrayInAnyOrder_aweXpect 2,604.6 ns 7.67 ns 7.17 ns 0.1678 - 2816 B
StringArrayInAnyOrder_FluentAssertions 90,874.8 ns 346.70 ns 289.51 ns 3.4180 - 58598 B

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 31, 2026

Test Results

     23 files   - 27       23 suites   - 27   8m 53s ⏱️ +22s
 19 521 tests  - 33   19 520 ✅  - 33  1 💤 ±0  0 ❌ ±0 
101 000 runs   - 81  100 999 ✅  - 81  1 💤 ±0  0 ❌ ±0 

Results for commit 9bcb145. ± Comparison against base commit 9c18e66.

This pull request removes 3115 and adds 3082 tests. Note that renamed tests count towards both.
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "message1551abf9-7952-4d0c-a169-cb62e970ba5a")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "message35f7744e-46ba-409c-b018-0d66a6bc52c4")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "message93ddbd26-1c70-454c-8063-cba044510c4c")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "messagec64443a5-5d55-47bf-97fe-bf1341f0ddda")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "messagec7a9699d-6a47-4974-bbe2-b9fa102e5fbc")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "messaged54ef1ca-e7e0-4970-a1ac-4ec53677bb8a")
aweXpect.Core.Tests.Core.Exceptions.SkipExceptionTests ‑ Message_ShouldBeSet(message: "message4851584f-91a7-4e62-8fe4-d160dad6e60e")
aweXpect.Core.Tests.Core.Exceptions.SkipExceptionTests ‑ Message_ShouldBeSet(message: "message64f6d3c4-0d2f-486f-b309-6525702662bb")
aweXpect.Core.Tests.Core.Exceptions.SkipExceptionTests ‑ Message_ShouldBeSet(message: "message8ffe3079-f1c4-4460-a28e-1c328f86064b")
aweXpect.Core.Tests.Core.Exceptions.SkipExceptionTests ‑ Message_ShouldBeSet(message: "messageae437d2c-02d9-44e3-8b30-256ceeaf7216")
…
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "message20c4f0f4-972b-4930-89b4-3e0c89c1d2fc")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "message2f9a998d-fb7b-4199-a04d-07edec63e3c2")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "message971276c0-b47e-47a1-8433-67a4aace7b43")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "message97ff0a28-ed99-429d-a1a1-aeaab7547530")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "messagea524b8b8-0793-4236-adec-fd911718f5ef")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "messagec321d509-92a5-45e8-bde6-1e1c5a86b79e")
aweXpect.Core.Tests.Core.Exceptions.SkipExceptionTests ‑ Message_ShouldBeSet(message: "message4ff36098-f33c-4d2d-90d7-0b3ca790ed8c")
aweXpect.Core.Tests.Core.Exceptions.SkipExceptionTests ‑ Message_ShouldBeSet(message: "message659a9d88-dac1-481f-8bfb-c8a139900035")
aweXpect.Core.Tests.Core.Exceptions.SkipExceptionTests ‑ Message_ShouldBeSet(message: "message7970ec71-fbcf-48d9-aa56-fc0983f74c00")
aweXpect.Core.Tests.Core.Exceptions.SkipExceptionTests ‑ Message_ShouldBeSet(message: "messageab5d2409-fbac-41c2-a0dd-cd88f4006375")
…

♻️ This comment has been updated with latest results.

@vbreuss vbreuss force-pushed the topic/update-pages branch from b9e6263 to 9bcb145 Compare January 31, 2026 05:42
@sonarqubecloud
Copy link
Copy Markdown

@vbreuss vbreuss marked this pull request as ready for review January 31, 2026 05:53
Copilot AI review requested due to automatic review settings January 31, 2026 05:53
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the documentation build pipeline to support nested directory structures when fetching extension documentation from GitHub. Previously, the pipeline only handled flat file structures; now it recursively processes directories.

Changes:

  • Extracted file download logic into a recursive helper method
  • Added support for detecting and processing directory structures from GitHub API responses
  • Maintained existing README content substitution functionality

Comment thread Pipeline/Build.Pages.cs
Comment thread Pipeline/Build.Pages.cs
@vbreuss vbreuss merged commit d34ed13 into main Jan 31, 2026
14 checks passed
@vbreuss vbreuss deleted the topic/update-pages branch January 31, 2026 06:22
github-actions Bot added a commit that referenced this pull request Jan 31, 2026
github-actions Bot added a commit that referenced this pull request Jan 31, 2026
@github-actions
Copy link
Copy Markdown
Contributor

This is addressed in release v2.31.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation state: released The issue is released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants