Skip to content

DEVDOCS-6233 | Content Refresh - "About Our APIs" #951

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

Merged
merged 10 commits into from
Jun 2, 2025
Merged

Conversation

bc-Vince
Copy link
Contributor

@bc-Vince bc-Vince commented May 21, 2025

Rewrote article to more closely resemble its equivalent for BigCommerce APIs

DEVDOCS-6233

What changed?

  • Available APIs and resources have more descriptive information
  • The article provides basic authentication information with links to learn more
  • The existing request header section now covers headers and structure for requests and responses, and also discusses GraphQL-specific considerations
  • There is a Resources section with helpful articles and developer support channels

Release notes draft

  • As part of our ongoing content refresh for B2B Edition developer documentation, we've fully refreshed the Storefront Quotes documentation. This includes:
    • A full list of B2B Edition APIs and available resources
    • Information on authenticating and structuring API requests
    • Tables for available request and response headers

Anything else?

ping @bc-terra

Rewrote article to more closely resemble its equivalent for BigCommerce APIs
@bc-Vince bc-Vince added the ready for review This PR is complete and awaiting a review. label May 21, 2025
@bc-terra
Copy link
Contributor

Less a suggestion and more a potential conversation.
Because we aren't under the constraints of the same system as KB, we can safely use relative links for anything that lives within developer.bc and anything that lives within a specific page.

A benefit of this is that links within dev-center can be shortened to exclude the domain. It doesn't hurt to include the domain, but it is implied by the lack of domain and protocol info.

This is doubly true for on-page anchors, which can be listed with just #anchor for example.

I'm willing to go either way on this, but we should make a decision and do what we can to be consistent about it.

@bc-Vince
Copy link
Contributor Author

Less a suggestion and more a potential conversation. Because we aren't under the constraints of the same system as KB, we can safely use relative links for anything that lives within developer.bc and anything that lives within a specific page.

A benefit of this is that links within dev-center can be shortened to exclude the domain. It doesn't hurt to include the domain, but it is implied by the lack of domain and protocol info.

This is doubly true for on-page anchors, which can be listed with just #anchor for example.

I'm willing to go either way on this, but we should make a decision and do what we can to be consistent about it.

@bc-terra Relative links and anchors without the root domain make sense to me. I tried a new method for generating the markdown in this PR, and I missed the link formatting as a result. I'll update affected links in a new commit.

bc-terra
bc-terra previously approved these changes May 28, 2025
@bc-Vince bc-Vince merged commit 975eabc into main Jun 2, 2025
3 checks passed
@bc-Vince bc-Vince deleted the bc-Vince-patch-1 branch June 2, 2025 18:39
@bc-Vince bc-Vince removed the ready for review This PR is complete and awaiting a review. label Jun 2, 2025
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