Repository navigation
Bring the package READMEs and an XML doc in line with the code - #444
Merged
Merged
Conversation
Hosting: the db commands point to the guide and the directory list gains ApiKeys/ and BackendDefaultTypes.cs. Core: no Attributes/ folder. UI.Core: the Blazor shared layer, not the Server host, uses it, and the shared list, filter, relation, value-change and degradation types are listed. Api.Contracts/Client/Core: the field value change call. Api.Server: ApiCallContext's members. Fluent: only the filter button is a text symbol. Blazor.Server: it references Polhem.Web.Blazor, which now states the UIServices rule. Definition: one layer name. Root README: Polhem.Templates, the Cli commands, dotnet polhem-define, and the Blazor live preview. DemoCenter and Northwind READMEs: duplicate row, property grid subjects, project tree, demo-ro, and the public demo master key. GetDepartmentTreeResponse: the per-request body codec.
…cope, and a few descriptions The Core README no longer lists Attributes/ (missed by the previous commit). The Web.Blazor README says which assemblies UIServicesUsageGateTests scans and that nothing checks the WebAssembly host's use of UIServices. UI.Core: the Blazor packages use everything but UIServices. Northwind: BlazorFluent is mounted by the Blazor head; the server also serves the WebAssembly heads. Fluent: only the grid's toolbar is icons. DemoCenter: the nested collections subject. Core and Definition share the Foundation layer name.
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
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.
Part of #441
Package READMEs (en and zh-TW together), one XML doc and one package description. Each statement was checked against the code; an adversarial review then compared every changed sentence with the source, and its findings are fixed in the second commit.
dbcommands point to the DatabaseSettings guide anddotnet run -- db(which lists them all) instead of naming three; the directory list gainsApiKeys/andBackendDefaultTypes.cs.Attributes/folder; Core and Definition share the Foundation layer name the dependency map uses.Polhem.Web.Blazor), not the Server host, uses it;ListFilterState,CardListState,LiveComputationDegradation,RelationOpenRulesandFieldValueChangeCoordinatorare listed (the Mud README already sends readers there).FieldValueChangeAsyncand its messages.ApiCallContextis the access token, whether the call is local, and the payload format.Polhem.Web.Blazorand the ASP.NET Core shared framework; the rule that keepsUIServicesandPolhem.UI.ApiBridgeout of the Blazor packages now lives in thePolhem.Web.BlazorREADME and says which assembliesUIServicesUsageGateTestsscans (not the WebAssembly host, whoseUIServicesuse nothing checks). Fluent: only the column filter button is a text symbol.Polhem.Templatesrow, the Cli row points to the Cli README for its commands, DefineEditor runs asdotnet polhem-define,Polhem.Expressionsserves the Blazor live preview too.Shared/and theDockerfile; the seeder writesdemo-rotoo; and a notice that the demo's master key is public, so a deployment built from the demo sets its ownPOLHEM_MASTER_KEY(ADR-015).GetDepartmentTreeResponsefollows the per-request body codec (ADR-044). Package description:Polhem.UI.ApiBridgeis for single-user front ends.Verified locally: the documentation checks, and a Release build of
Polhem.Api.Core. Lite CI.