Skip to content

docs: reorganize documentation structure for clarity and improved navigation #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
JerrettDavis merged 1 commit into from
Dec 28, 2025
Merged

docs: reorganize documentation structure for clarity and improved navigation #9

JerrettDavis merged 1 commit into from
Dec 28, 2025

Conversation

@JerrettDavis
Copy link
Owner

@JerrettDavis JerrettDavis commented Dec 28, 2025 •
edited
Loading

No description provided.

@JerrettDavis JerrettDavis added the documentation Improvements or additions to documentation label Dec 28, 2025
@JerrettDavis JerrettDavis changed the title docs: reorganize documentation structure for clarity and improved nav… docs: reorganize documentation structure for clarity and improved navigation Dec 28, 2025
@github-actions
Copy link

github-actions bot commented Dec 28, 2025

Code Coverage

Summary
  Generated on: 12/28/2025 - 02:03:37
  Coverage date: 12/28/2025 - 02:03:08 - 12/28/2025 - 02:03:29
  Parser: MultiReport (2x Cobertura)
  Assemblies: 10
  Classes: 134
  Files: 115
  Line coverage: 87.8%
  Covered lines: 4074
  Uncovered lines: 566
  Coverable lines: 4640
  Total lines: 16951
  Branch coverage: 76.4% (1604 of 2097)
  Covered branches: 1604
  Total branches: 2097
  Method coverage: 94.3% (614 of 651)
  Full method coverage: 80.6% (525 of 651)
  Covered methods: 614
  Fully covered methods: 525
  Total methods: 651

ExperimentFramework                                                               93.9%
  ExperimentFramework.Activation.ActivationEvaluator                              93.1%
  ExperimentFramework.Activation.SystemTimeProvider                                100%
  ExperimentFramework.Decorators.BenchmarkDecoratorFactory                         100%
  ExperimentFramework.Decorators.DecoratorPipeline                                 100%
  ExperimentFramework.Decorators.ErrorLoggingDecoratorFactory                      100%
  ExperimentFramework.Decorators.TimeoutDecoratorFactory                           100%
  ExperimentFramework.ExperimentBuilder                                           74.3%
  ExperimentFramework.ExperimentBuilderExtensions                                  100%
  ExperimentFramework.ExperimentFrameworkBuilder                                   100%
  ExperimentFramework.ExperimentLoggingBuilder                                     100%
  ExperimentFramework.ExperimentRegistry                                           100%
  ExperimentFramework.KillSwitch.ExperimentDisabledException                       100%
  ExperimentFramework.KillSwitch.InMemoryKillSwitchProvider                        100%
  ExperimentFramework.KillSwitch.KillSwitchDecoratorFactory                        100%
  ExperimentFramework.KillSwitch.NoopKillSwitchProvider                            100%
  ExperimentFramework.KillSwitch.TrialDisabledException                            100%
  ExperimentFramework.Metrics.MetricsDecoratorFactory                              100%
  ExperimentFramework.Metrics.NoopExperimentMetrics                                100%
  ExperimentFramework.Models.BehaviorRule                                          100%
  ExperimentFramework.Models.Experiment                                            100%
  ExperimentFramework.Models.ExperimentRegistration                                 75%
  ExperimentFramework.Models.SelectionModeExtensions                               100%
  ExperimentFramework.Models.SelectionRule                                         100%
  ExperimentFramework.Models.ServiceExperimentDefinition<T>                        100%
  ExperimentFramework.Models.Trial                                                 100%
  ExperimentFramework.Naming.DefaultExperimentNamingConvention                     100%
  ExperimentFramework.Naming.ExperimentSelectorName                                100%
  ExperimentFramework.RuntimeExperimentProxy<T>                                   81.8%
  ExperimentFramework.Selection.Providers.BooleanFeatureFlagProvider               100%
  ExperimentFramework.Selection.Providers.BooleanFeatureFlagProviderFactory        100%
  ExperimentFramework.Selection.Providers.ConfigurationValueProvider                80%
  ExperimentFramework.Selection.Providers.ConfigurationValueProviderFactory        100%
  ExperimentFramework.Selection.SelectionModeAttribute                             100%
  ExperimentFramework.Selection.SelectionModeProviderBase                          100%
  ExperimentFramework.Selection.SelectionModeProviderFactory<T>                    100%
  ExperimentFramework.Selection.SelectionModeRegistry                              100%
  ExperimentFramework.ServiceCollectionExtensions                                 99.1%
  ExperimentFramework.ServiceExperimentBuilder<T>                                 93.8%
  ExperimentFramework.Telemetry.NoopExperimentTelemetry                            100%
  ExperimentFramework.Telemetry.OpenTelemetryExperimentTelemetry                   100%
  ExperimentFramework.Validation.TrialConflictDetector                            98.7%
  ExperimentFramework.Validation.TrialConflictException                            100%
  ExperimentFramework.Variants.VariantFeatureManagerAdapter                        100%

ExperimentFramework.Configuration                                                 77.8%
  ExperimentFramework.Configuration.Building.ConfigurationExperimentBuilder       73.8%
  ExperimentFramework.Configuration.Building.TypeResolver                           69%
  ExperimentFramework.Configuration.ConfigurationFileWatcher                        90%
  ExperimentFramework.Configuration.Exceptions.ConfigurationLoadException          100%
  ExperimentFramework.Configuration.Exceptions.ExperimentConfigurationException    100%
  ExperimentFramework.Configuration.Exceptions.TypeResolutionException             100%
  ExperimentFramework.Configuration.Loading.ConfigurationFileDiscovery             100%
  ExperimentFramework.Configuration.Loading.ExperimentConfigurationLoader         84.6%
  ExperimentFramework.Configuration.Models.CircuitBreakerDecoratorOptions          100%
  ExperimentFramework.Configuration.Models.OutcomeCollectionDecoratorOptions       100%
  ExperimentFramework.Configuration.Models.TimeoutDecoratorOptions                 100%
  ExperimentFramework.Configuration.ServiceCollectionExtensions                   89.3%
  ExperimentFramework.Configuration.Validation.ConfigurationValidationError        100%
  ExperimentFramework.Configuration.Validation.ConfigurationValidationResult       100%
  ExperimentFramework.Configuration.Validation.ConfigurationValidator             67.3%

ExperimentFramework.Data                                                          92.2%
  ExperimentFramework.Data.Decorators.OutcomeCollectionDecoratorFactory            100%
  ExperimentFramework.Data.ExperimentBuilderExtensions                               0%
  ExperimentFramework.Data.Models.ExperimentOutcome                                  0%
  ExperimentFramework.Data.Models.OutcomeAggregation                              94.1%
  ExperimentFramework.Data.Models.OutcomeQuery                                       0%
  ExperimentFramework.Data.Recording.OutcomeRecorder                               100%
  ExperimentFramework.Data.Recording.OutcomeRecorderOptions                        100%
  ExperimentFramework.Data.ServiceCollectionExtensions                             100%
  ExperimentFramework.Data.Storage.InMemoryOutcomeStore                           90.9%
  ExperimentFramework.Data.Storage.NoopOutcomeStore                                100%

ExperimentFramework.FeatureManagement                                              100%
  ExperimentFramework.FeatureManagement.ExperimentBuilderExtensions                100%
  ExperimentFramework.FeatureManagement.ServiceCollectionExtensions                100%
  ExperimentFramework.FeatureManagement.VariantFeatureFlagProvider                 100%

ExperimentFramework.Metrics.Exporters                                             99.3%
  ExperimentFramework.Metrics.Exporters.OpenTelemetryExperimentMetrics             100%
  ExperimentFramework.Metrics.Exporters.PrometheusExperimentMetrics               99.2%

ExperimentFramework.OpenFeature                                                    100%
  ExperimentFramework.OpenFeature.ExperimentBuilderExtensions                      100%
  ExperimentFramework.OpenFeature.OpenFeatureProvider                              100%
  ExperimentFramework.OpenFeature.ServiceCollectionExtensions                      100%

ExperimentFramework.Plugins                                                         87%
  ExperimentFramework.Plugins.Abstractions.PluginEventArgs                         100%
  ExperimentFramework.Plugins.Abstractions.PluginLoadFailedEventArgs               100%
  ExperimentFramework.Plugins.Configuration.PluginConfigurationValidator           100%
  ExperimentFramework.Plugins.Configuration.PluginDiscoveryService                 100%
  ExperimentFramework.Plugins.Configuration.PluginsConfig                          100%
  ExperimentFramework.Plugins.HotReload.PluginReloadEventArgs                      100%
  ExperimentFramework.Plugins.HotReload.PluginReloadFailedEventArgs                100%
  ExperimentFramework.Plugins.HotReload.PluginReloadService                        100%
  ExperimentFramework.Plugins.HotReload.PluginWatcher                             87.8%
  ExperimentFramework.Plugins.Integration.PluginBuilderExtensions                  100%
  ExperimentFramework.Plugins.Integration.PluginManager                           83.3%
  ExperimentFramework.Plugins.Integration.PluginTypeResolver                       100%
  ExperimentFramework.Plugins.Loading.PluginContext                               55.4%
  ExperimentFramework.Plugins.Loading.PluginLoadContext                             72%
  ExperimentFramework.Plugins.Loading.PluginLoader                                91.9%
  ExperimentFramework.Plugins.Loading.SharedTypeRegistry                          89.1%
  ExperimentFramework.Plugins.Manifest.ManifestLoader                               92%
  ExperimentFramework.Plugins.Manifest.ManifestValidationResult                     50%
  ExperimentFramework.Plugins.Manifest.ManifestValidator                          97.7%
  ExperimentFramework.Plugins.Manifest.PluginManifest                              100%
  ExperimentFramework.Plugins.Manifest.PluginManifestAttribute                     100%
  ExperimentFramework.Plugins.Manifest.PluginManifestJson                          100%
  ExperimentFramework.Plugins.Security.PluginSecurityValidator                      73%
  ExperimentFramework.Plugins.ServiceCollectionDecoratorExtensions                70.5%
  ExperimentFramework.Plugins.ServiceCollectionExtensions                          100%

ExperimentFramework.Resilience                                                     100%
  ExperimentFramework.Resilience.CircuitBreakerDecoratorFactory                    100%
  ExperimentFramework.Resilience.CircuitBreakerOpenException                       100%
  ExperimentFramework.Resilience.CircuitBreakerOptions                             100%
  ExperimentFramework.Resilience.ResilienceBuilderExtensions                       100%

ExperimentFramework.Science                                                       88.8%
  ExperimentFramework.Science.Analysis.ExperimentAnalyzer                         88.3%
  ExperimentFramework.Science.Builders.EndpointBuilder                             100%
  ExperimentFramework.Science.Builders.HypothesisBuilder                           100%
  ExperimentFramework.Science.Builders.SuccessCriteriaBuilder                      100%
  ExperimentFramework.Science.Corrections.BenjaminiHochbergCorrection              100%
  ExperimentFramework.Science.Corrections.BonferroniCorrection                     100%
  ExperimentFramework.Science.Corrections.HolmBonferroniCorrection                 100%
  ExperimentFramework.Science.EffectSize.CohensD                                   100%
  ExperimentFramework.Science.EffectSize.EffectSizeExtensions                      100%
  ExperimentFramework.Science.EffectSize.OddsRatio                                 100%
  ExperimentFramework.Science.EffectSize.RelativeRisk                              100%
  ExperimentFramework.Science.Models.Hypothesis.Endpoint                             0%
  ExperimentFramework.Science.Models.Hypothesis.HypothesisDefinition                 0%
  ExperimentFramework.Science.Models.Results.StatisticalTestResult                66.6%
  ExperimentFramework.Science.Models.Snapshots.EnvironmentInfo                       0%
  ExperimentFramework.Science.Power.PowerAnalyzer                                 78.7%
  ExperimentFramework.Science.Reporting.JsonReporter                              88.8%
  ExperimentFramework.Science.Reporting.MarkdownReporter                          72.8%
  ExperimentFramework.Science.ServiceCollectionExtensions                          100%
  ExperimentFramework.Science.Snapshots.InMemorySnapshotStore                     90.1%
  ExperimentFramework.Science.Statistics.ChiSquareTest                            79.1%
  ExperimentFramework.Science.Statistics.MannWhitneyUTest                         97.3%
  ExperimentFramework.Science.Statistics.OneWayAnova                              98.4%
  ExperimentFramework.Science.Statistics.PairedTTest                              81.5%
  ExperimentFramework.Science.Statistics.TwoSampleTTest                           88.4%

ExperimentFramework.StickyRouting                                                 92.5%
  ExperimentFramework.StickyRouting.ExperimentBuilderExtensions                    100%
  ExperimentFramework.StickyRouting.ServiceCollectionExtensions                    100%
  ExperimentFramework.StickyRouting.StickyRoutingProvider                         86.6%
  ExperimentFramework.StickyRouting.StickyTrialRouter                              100%

@codecov-commenter
Copy link

codecov-commenter commented Dec 28, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@1840f87). Learn more about missing BASE report.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main       #9   +/-   ##
=======================================
  Coverage        ?   89.63%           
=======================================
  Files           ?      116           
  Lines           ?     4641           
  Branches        ?      816           
=======================================
  Hits            ?     4160           
  Misses          ?      481           
  Partials        ?        0
Flag Coverage Δ
unittests 89.63% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@JerrettDavis JerrettDavis merged commit 3de7602 into main Dec 28, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@JerrettDavis @codecov-commenter