mirror of
https://github.com/microsoft/BCQuality.git
synced 2026-10-06 15:16:56 +01:00
Improve partner onboarding and documentation navigation
Lead with a complete plugin quick start and add task-oriented usage, troubleshooting, customization, and contribution guides. Preserve the broader plugin framing, correct conflicting contract guidance, support Agents folder reviews, and align repository validation. Convert existing sample references to clickable links without changing knowledge rules. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
parent
a21edfec46
commit
b6da405376
276 changed files with 1287 additions and 756 deletions
|
|
@ -17,10 +17,10 @@ API pages — pages declared with `PageType = API` — surface as OData/JSON end
|
|||
|
||||
Pick camelCase identifiers up front: `APIPublisher = 'contoso'`, `APIGroup = 'app1'`, `EntityName = 'customer'`, field `Name = 'displayName'`. Keep them short — they end up in URL paths and JSON keys that every consumer types.
|
||||
|
||||
See sample: `api-page-camelcase-properties.good.al`.
|
||||
See sample: [`api-page-camelcase-properties.good.al`](api-page-camelcase-properties.good.al).
|
||||
|
||||
## Anti Pattern
|
||||
|
||||
`APIPublisher = 'Contoso-App'` (hyphen rejected, capitalization wrong for camelCase), `EntityName = 'sales_order'` (underscore rejected), or fields exposed with `Name = 'Display Name'` (space rejected). The compiler usually catches these, but the failure mode is opaque and the rename cost on a deployed API is high.
|
||||
|
||||
See sample: `api-page-camelcase-properties.bad.al`.
|
||||
See sample: [`api-page-camelcase-properties.bad.al`](api-page-camelcase-properties.bad.al).
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue