docs(typescript): API reference master#60
Merged
Conversation
|
Important Review skippedToo many files! This PR contains 300 files, which is 150 over the limit of 150. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (300)
You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
github-actions
Bot
added
area:content
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request transitions the TypeScript SDK documentation from a component-centric reference to a package-oriented structure, introducing detailed API documentation for the @resq-sw/analytics package. Feedback highlights that documentation for the @resq-sw/ui package was removed and should be restored if still relevant. Furthermore, the package list in the README requires navigation links to the documentation entry points, and documentation for several other listed packages is currently absent from the PR.
| @@ -1,126 +1,13 @@ | |||
| # @resq-sw/ui | |||
| # ResQ TypeScript SDK | |||
There was a problem hiding this comment.
The documentation for the @resq-sw/ui package (previously located under components/) has been removed and is not included in the new package list. If this package is still part of the ResQ TypeScript SDK, its documentation should be retained or regenerated under the new structure.
Comment on lines
+7
to
+13
| - `@resq-sw/analytics` — `v0.3.0` | ||
| - `@resq-sw/decorators` — `v0.1.1` | ||
| - `@resq-sw/dsa` — `v0.1.0` | ||
| - `@resq-sw/http` — `v0.1.1` | ||
| - `@resq-sw/logger` — `v0.1.1` | ||
| - `@resq-sw/rate-limiting` — `v0.1.1` | ||
| - `@resq-sw/security` — `v0.1.1` |
There was a problem hiding this comment.
This package list has two main issues:\n1. Missing Navigation: The package names are plain text. They should be links to their respective documentation entry points (e.g., ./analytics/index.md) to allow users to browse the reference.\n2. Incomplete PR: Documentation files for 6 of the 7 listed packages (all except analytics) are missing from this pull request. Only the @resq-sw/analytics directory was added.
- [@resq-sw/analytics](./analytics/index.md) — `v0.3.0`\n- [@resq-sw/decorators](./decorators/index.md) — `v0.1.1`\n- [@resq-sw/dsa](./dsa/index.md) — `v0.1.0`\n- [@resq-sw/http](./http/index.md) — `v0.1.1`\n- [@resq-sw/logger](./logger/index.md) — `v0.1.1`\n- [@resq-sw/rate-limiting](./rate-limiting/index.md) — `v0.1.1`\n- [@resq-sw/security](./security/index.md) — `v0.1.1`
WomB0ComB0
added a commit
that referenced
this pull request
May 10, 2026
After the multi-package TS refactor (#58), each package showed up twice in the TypeScript sub-group: - once as a standalone PAGE entry (e.g. \`analytics\`) - once as a collapsible GROUP entry (\`{group: \"analytics\", pages: [\"analytics/index/...\"]}\`) Root cause: the splice's \`/index\` strip turned \`analytics/index\` into the bare path \`analytics\`, which got registered as a leaf file at the parent level. Then \`analytics/index/classes/Analytics\` (and siblings) created a sibling \`analytics/\` directory tree. Both ended up in the parent group's pages list. Fix: introduce \`insert_landing()\` which stores the landing page id on the dir node itself (\`_landing\`) rather than as a sibling \`_files\` leaf. \`to_mintlify\` emits \`_landing\` first inside the dir's group, before any \`_files\` or sub-\`_dirs\`. Result: each package gets exactly one collapsible group, with its landing page as the first child. Applied to both: - automation/source-repo-templates/api-docs.typescript.yml (used at doc-generation time) - scripts/splice-sdk-nav.py (used for local re-splicing across all languages: TS, .NET, Python, Rust, C++) docs.json re-spliced locally to clear the duplicates already on main from PR #60. Co-authored-by: Mike Odnis <engineer@resq.software>
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.
Auto-generated by
api-docsinresq-software/npmfor refmaster(run: 25623068959).
Regenerated files under
sdks/typescript/api/. Onesub-directory per
@resq-sw/*package. Review the difffor unintended exports and merge to publish.