Skip to content

docs: avoid duplicate documentation#81

Merged
vbreuss merged 1 commit intomainfrom
topic/avoid-duplicate-documentation
Aug 14, 2025
Merged

docs: avoid duplicate documentation#81
vbreuss merged 1 commit intomainfrom
topic/avoid-duplicate-documentation

Conversation

@vbreuss
Copy link
Copy Markdown
Member

@vbreuss vbreuss commented Aug 14, 2025

Replace the duplicated documentation in "00-index.md" with "{README}" which will be replaced by the content of README.md with Testably/aweXpect#721.

Replace the duplicated documentation in "00-index.md" with "{README}" which will be replaced by the content of README.md with Testably/aweXpect#721.
@vbreuss vbreuss self-assigned this Aug 14, 2025
Copilot AI review requested due to automatic review settings August 14, 2025 19:17
@vbreuss vbreuss added the documentation Improvements or additions to documentation label Aug 14, 2025
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 removes duplicate documentation from the index file and replaces it with a placeholder that will be populated with README content. The change eliminates code duplication by centralizing documentation content in the README.md file.

  • Removes 155 lines of duplicated HttpClient expectations documentation
  • Replaces removed content with {README} placeholder for dynamic content injection

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@vbreuss vbreuss enabled auto-merge (squash) August 14, 2025 19:18
@sonarqubecloud
Copy link
Copy Markdown

@github-actions
Copy link
Copy Markdown

Test Results

   10 files  ±0     10 suites  ±0   6s ⏱️ -1s
  484 tests ±0    483 ✅ ±0  1 💤 ±0  0 ❌ ±0 
1 440 runs  ±0  1 439 ✅ ±0  1 💤 ±0  0 ❌ ±0 

Results for commit 74c229d. ± Comparison against base commit c0e2484.

@vbreuss vbreuss merged commit 8d077af into main Aug 14, 2025
12 checks passed
@vbreuss vbreuss deleted the topic/avoid-duplicate-documentation branch August 14, 2025 19:22
@github-actions
Copy link
Copy Markdown

🚀 Benchmark Results

Details

BenchmarkDotNet v0.14.0, Ubuntu 24.04.2 LTS (Noble Numbat)
AMD EPYC 7763, 1 CPU, 4 logical and 2 physical cores
.NET SDK 9.0.304
[Host] : .NET 8.0.19 (8.0.1925.36514), X64 RyuJIT AVX2
DefaultJob : .NET 8.0.19 (8.0.1925.36514), X64 RyuJIT AVX2

Method Mean Error StdDev Gen0 Allocated
Content_aweXpect 494.4 ns 2.92 ns 2.44 ns 0.0629 1064 B
SuccessStatusCode_aweXpect 268.9 ns 2.14 ns 1.90 ns 0.0496 832 B

@github-actions
Copy link
Copy Markdown

👽 Mutation Results

Mutation testing badge

aweXpect.Web

Details
File Score Killed Survived Timeout No Coverage Ignored Compile Errors Total Detected Total Undetected Total Mutants

The final mutation score is NaN%

Coverage Thresholds: high:80 low:60 break:0

@github-actions
Copy link
Copy Markdown

This is addressed in release v1.4.0.

@github-actions github-actions Bot added the state: released The issue is released label Sep 10, 2025
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