Conversation
…ure (#3043) * Add first draft from old PRs * Re-order sections alphabetically * Fix a few things reported by Integrity Checker (Code Verifier) * Fix isComponentAttribute description * [Integrity Checker] Fix z import: not exported from @strapi/utils z is not re-exported from @strapi/utils, only validateZod is. Users must import z directly from the zod package. Also clarify that validateZod returns parsed data on success. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * [Integrity Checker] Remove non-existent strictParams and route options The Options interface in both sanitize and validate only defines auth. strictParams and route do not exist in the codebase. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * [Integrity Checker] Fix toRegressedEnumValue description The function does not produce UPPER_SNAKE_CASE. It uses slugify with lowercase: false, preserving original casing with underscore separators. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * [Integrity Checker] Complete validateYupSchema/Sync signatures Add missing options parameter and document the returned function signature (body, errorMessage?) with default options { strict: true, abortEarly: false }. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * [Integrity Checker] Clarify env.json and env.oneOf behavior env.json: specify it throws a wrapped Error with descriptive message, not the raw SyntaxError. env.oneOf: clarify that non-matching values silently return default, and document the two specific throw conditions. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * [Integrity Checker] Document withDefaultPagination options parameter Add missing documentation for the defaults and maxLimit options. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Revert "[Integrity Checker] Remove non-existent strictParams and route options" This reverts commit 9921e1b. * Revert "[Integrity Checker] Fix z import: not exported from @strapi/utils" This reverts commit 7256a10. * [Integrity Checker] Add strapi-utils to sidebar Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * [Integrity Checker] Add strapi-utils entry to llms.txt Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * [Integrity Checker] Fix error default messages in error-handling docs Fix ApplicationError typo 'occured' → 'occurred' and align NotImplementedError default to match source: 'This feature is not implemented yet' Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * [Integrity Checker] Fix duplicated cell and add link in strapi-utils-refactored Remove duplicated table cell content on line 32 and add link to the full strapi-utils documentation in the additional notes section. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Move cross-ref to strapi-utils doc to bottom of breaking change page * Remove unwanted blank line in BC file * [UX Review] Replace generic 'Usage example' headings with descriptive text Replace 7 identical '### Usage example' h3 headings with contextual sentences ending with a colon, reducing TOC noise while preserving the code examples themselves. * [UX Review] Remove single-child h3 headings from strapi-utils Remove h3s that were the only sub-section of their parent h2: Available methods (env), Parameters (parseType, setCreatorFields), Return values by type (parseType), createAPISanitizers (sanitize), createAPIValidators (validate), validateZod (zod). Content is preserved as inline text with function names in backticks. * [UX Review] Limit TOC to h2 headings and fix example intro sentences Add toc_max_heading_level: 2 to keep only the 17 top-level sections in the secondary navbar. Rewrite example intro lines as proper sentences starting with 'The following example…'. * [UX Review] Sort table rows alphabetically in strapi-utils Sort function/method tables alphabetically by first column in: async, contentTypes (attribute + schema inspection), env methods, file, pagination, strings, and relations. Tables kept in non-alphabetical order where a logical grouping makes more sense: contentTypes constants (semantic pairs), errors (inheritance hierarchy), hooks methods/factories (lifecycle order), providerFactory methods/hooks (CRUD lifecycle), parseType params (function signature order), yup methods (by schema type). * [UX Review] Add usage example for contentTypes section Add an example that demonstrates iterating over attributes to find relations, retrieving writable fields, and checking draft-and-publish support — the most common contentTypes use cases. * [UX Review] Add lead-in sentences before all code blocks and tables Ensure every code block, table, and structured element is introduced by a complete sentence, following Google/Microsoft docs style guides and the editorial convention used across the rest of the Strapi docs. * [UX Review] Encode lead-in sentence rule in CMS authoring guide Add editorial rule to AGENTS.cms.md requiring every code block, table, or structured element to be preceded by a complete introductory sentence. This ensures the Drafter applies the convention from the start. * [UX Review] Add scalar value annotation and fix missing import intros Add an inline <Annotation> on 'scalar value' in the contentTypes attribute inspection table. Add lead-in sentences before the Tabs import blocks in the env and errors sections. * Fix code block title format and encode rule in authoring guide Remove 'path:' prefix from code block title in strapi-utils. Update AGENTS.cms.md to clarify that title= should contain the file path directly, never prefixed with 'path:'. * Remove 'path:' prefix from code block titles across CMS docs Fix title= attributes in deployment.md, middlewares.md, and error-handling.md to use the file path directly without 'path:'. * Fix parseType table intro to be a proper sentence * Fix snake_case not shown as inline code * Add series hook annotation, policy section intro with anchor cross-links, and createPolicyContext lead-in * Fix 'provides' to 'provides the following' in sanitize/validate sections * Rewrite ambiguous 'Create a set of…' lead-ins as descriptive sentences * Expand sanitize/validate options into a detailed table with auth, strictParams, route * Bold annotated terms: **scalar value** and **series hook** * Encode Annotation component rules in CMS authoring guide * Add Annotation component template and simplify authoring guide reference * Fix config → configuration * Fix Tabs values and default attributes per template rules * Improve clarity: intro nav hint, disambiguate descriptions, explain jargon, add cross-refs * Move sanitize tip before factory pattern and explain model resolver * Add validate tip, usage example with error handling * Add hook type comparison guidance, expand zod section with return/error details * Address final UX review: clarify jargon, add examples, fix consistency, improve discoverability * Fix annotation tooltip clipped by table overflow: auto * Add Annotation on curried function in setCreatorFields * Replace em dashes with standard punctuation * Encode no-em-dash rule in CMS authoring guide and fix existing em dash * Add directory export section to Data export page * Add directory import section to Data import page * Update CLI reference with directory export/import options * Split CLI export/import examples into separate code blocks * Update llms* files --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
1 participant
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.
Automatic sync of commit from main