Improve MiniProfiler module documentation - #19631
Open
agriffard wants to merge 1 commit into
Open
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
MikeAlhayek
reviewed
Aug 5, 2026
| The feature can also be enabled from a recipe: | ||
|
|
||
| ```json | ||
| { |
Member
There was a problem hiding this comment.
To avoid copy/paste issues, should wrap this with
{
"steps": [
// the step code goes here
]
}
Comment on lines
+20
to
+33
| For development applications, the host can make the feature always enabled for every tenant: | ||
|
|
||
| ```csharp | ||
| using Microsoft.Extensions.DependencyInjection; | ||
|
|
||
| var builder = WebApplication.CreateBuilder(args); | ||
|
|
||
| var orchardCoreBuilder = builder.Services.AddOrchardCms(); | ||
|
|
||
| if (builder.Environment.IsDevelopment()) | ||
| { | ||
| orchardCoreBuilder.EnableFeature("OrchardCore.MiniProfiler"); | ||
| } | ||
| ``` |
Member
There was a problem hiding this comment.
this section is not needed. The MiniProfiler is a feature that can be enabled/disabled via UI and that should ne enough. this is not a special use case for MiniProfile and can be used for any feature
|
|
||
| Requests that do not render an Orchard layout, such as APIs and decoupled responses, are still profiled but do not receive a widget. The widget also requires the active theme or admin theme to render the `Footer` zone. | ||
|
|
||
| ## Configure MiniProfiler |
Member
There was a problem hiding this comment.
this is just too much to share in the document
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The MiniProfiler reference still described a removed admin option and omitted important runtime and security behavior. This update aligns the canonical guidance with the current module implementation.
Validation
python -m mkdocs build