Feat: Ensure docs site works with OAS (@W-18483003@)#426
Merged
joeluong-sfcc merged 10 commits intofeature/oasfrom Jul 17, 2025
Merged
Feat: Ensure docs site works with OAS (@W-18483003@)#426joeluong-sfcc merged 10 commits intofeature/oasfrom
joeluong-sfcc merged 10 commits intofeature/oasfrom
Conversation
joeluong-sfcc
commented
Jul 16, 2025
| "typedoc-plugin-external-module-map": "1.2.1", | ||
| "typedoc-plugin-nojekyll": "^1.0.1", | ||
| "typescript": "~5.1.0" |
Collaborator
Author
There was a problem hiding this comment.
Originally upgraded to fix a linting issue, but the linting issue is not appearing any longer so dropping these dependencies down to keep it in alignment with commerce-sdk-isomorphic
Collaborator
adamraya
reviewed
Jul 16, 2025
adamraya
reviewed
Jul 16, 2025
Collaborator
Author
Done
Added details for both these files in the |
unandyala
approved these changes
Jul 17, 2025
adamraya
approved these changes
Jul 17, 2025
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.

This PR updates the docs to reflect the new OAS changes in the Isomorphic SDK. Due to the restructuring of the SDK, there's additional complexity to navigating the docs site. A section has been added in the README for clarity.
This is almost identical to the isomorphic SDK site, however, since there are a large number of APIs, when you navigate to an API class, the right sidebar to navigate through the API classes disappears and you have to click on
Globalsto navigate back. A section was added in the README to describe this difference.Synk CI check will be fixed in another PR.
To test this PR:
git checkout ju/oas-docsopen docs/index.html