Skip to content

Feat: Ensure docs site works with OAS (@W-18483003@)#426

Merged
joeluong-sfcc merged 10 commits intofeature/oasfrom
ju/oas-docs
Jul 17, 2025
Merged

Feat: Ensure docs site works with OAS (@W-18483003@)#426
joeluong-sfcc merged 10 commits intofeature/oasfrom
ju/oas-docs

Conversation

@joeluong-sfcc
Copy link
Collaborator

@joeluong-sfcc joeluong-sfcc commented Jul 16, 2025

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 Globals to 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:

  1. git checkout ju/oas-docs
  2. run open docs/index.html
  3. navigate the docs site

@joeluong-sfcc joeluong-sfcc marked this pull request as ready for review July 16, 2025 16:24
@joeluong-sfcc joeluong-sfcc requested a review from a team as a code owner July 16, 2025 16:24
"typedoc-plugin-external-module-map": "1.2.1",
"typedoc-plugin-nojekyll": "^1.0.1",
"typescript": "~5.1.0"
Copy link
Collaborator Author

@joeluong-sfcc joeluong-sfcc Jul 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@unandyala
Copy link
Collaborator

unandyala commented Jul 16, 2025

image

Can we removed quotes around "index", "types", "version"?
Does "types" included common types shared between classes?
What us "version" module? Can we add few more details in the docs?

@joeluong-sfcc
Copy link
Collaborator Author

Can we removed quotes around "index", "types", "version"?

Done

Does "types" included common types shared between classes?
What us "version" module? Can we add few more details in the docs?

Added details for both these files in the README

@joeluong-sfcc joeluong-sfcc merged commit 0c2474a into feature/oas Jul 17, 2025
6 of 7 checks passed
@joeluong-sfcc joeluong-sfcc deleted the ju/oas-docs branch July 17, 2025 20:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants