Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added reference for JS Client #1629

Merged
merged 6 commits into from
Jul 8, 2022
Merged

docs: added reference for JS Client #1629

merged 6 commits into from
Jul 8, 2022

Conversation

shahednasser
Copy link
Member

This PR adds a new reference to the documentation covering the Medusa JS Client.

  • Added new Typedoc plugins to customize the generation of the reference
  • Created a custom Typedoc plugin to add frontmatter data at the top of specific markdown files. This is necessary to display the sidebar in the reference on some of the deeply-nested pages that do not appear on the sidebar.
  • Added a new link in the sidebar "JS Client Reference"
  • In the JS Client Reference, added an overview page to introduce the client and how the reference can be used.
  • Added a new sidebar for the JS Client reference. Due to the hierarchy of the reference package and to make the reference easier to use, the sidebar is manually created and not autogenerated.
  • Added in the README of the JS Client a link to the new reference and changed the homepage URL of the package.

I did not create a GitHub action for this reference as it might mess up the sidebar. It's better to attend to any changes manually to make sure the documentation always functions properly.

Closes #1570

Question: Should we have in the navigation bar a "References" dropdown or should we keep the references linked separately?

@shahednasser shahednasser requested review from a team as code owners June 8, 2022 12:15
@changeset-bot
Copy link

changeset-bot bot commented Jul 5, 2022

⚠️ No Changeset found

Latest commit: 2c1fd39

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Collaborator

@srindom srindom left a comment

Choose a reason for hiding this comment

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

LGTM! Let's get this in!

Regarding your question I think it would be cool with a drop-down :)

@shahednasser shahednasser merged commit 3b28f46 into master Jul 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Create "JS Client" documentation under Advanced Usage > Storefront and move Carts documentation
2 participants