Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .claude/skills/sdk-docs-writing/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ Every public method needs: description, `@param` tags, `@returns`, and at least
- **State environment constraints** when a method is browser-only: "Requires a browser environment and can't be used in the backend."
- **Document side effects** explicitly (e.g., "automatically sets the token for subsequent requests").
- **Link method references.** When mentioning another SDK method or module by name in JSDoc prose, always use `{@link}` or `{@linkcode}` to create a cross-reference.
- **Never use a colon as a sentence break.** Write "Use this when you sync data from another system. Name the field..." not "...another system: name the field...". Reserve colons for `label: description` bullet-list items, not prose sentences.
- **Never start a sentence with a lowercase inline-code term.** If the natural phrasing would open with one (e.g., "`week` is only supported on..."), restructure so a capitalized word leads instead (e.g., "Every date field supports `day`, `month` and `year`. The `created_date` and `updated_date` fields also support `week`.").

## References

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"interfaces/EntityHandler",
"type-aliases/EntityRecord",
"interfaces/EntityTypeRegistry",
"type-aliases/SortField"
"type-aliases/SortField",
"type-aliases/EntityFilterQuery"
],
"interfaces/FunctionsModule": [
"type-aliases/FunctionName",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,12 @@ function updateDocsJson(repoDir, sdkFiles) {
return Array.from(groupMap.entries()).map(([group, pages]) => ({
group,
expanded: true,
pages: pages.sort(),
// Sort by basename, not full path: a plain .sort() groups all
// "interfaces/..." entries before "type-aliases/..." entries (since
// "i" < "t"), instead of interleaving both kinds alphabetically by
// module name. Keep in sync with the same fix in
// file-processing/file-processing.js's generateDocsJson.
pages: pages.sort((a, b) => a.split("/").pop().localeCompare(b.split("/").pop())),
}));
};

Expand Down
Loading
Loading