You've found the BigCommerce documentation GitHub repository, which contains the public content for the BigCommerce Developer Center.
This repo is the source of truth for our public, open source documentation and API reference at developer.bigcommerce.com. It consists of Markdown React (.mdx), OpenAPI Specification (.yml), and JSON Schema (.json and .yml) files.
The BigCommerce DX team maintains these open source docs; we welcome your issues, discussions, and pull requests!
Thanks for your interest in contributing to our documentation! Below are a few quick ways to get started:
Here are some quick links to our Contribution guide:
- Start a Discussion. Our DevDocs team monitors GitHub Discussions regularly.
- Open a new Issue. Our DevDocs team monitors GitHub Issues regularly.
For more information, see our Contribution Guidelines and Code of conduct.
If you maintain API clients, this repository is your source for the most up-to-date public API specifications.
Always update your fork to ensure you're working with the newest source files.
. โโโ .github/ # github config โโโ workflows/ # workflows to lint pull requests, etc. โโโ ... โโโ .idea/ # directory ignored by git - use for yourself โโโ .style/ # CSPELL data files โโโ assets/ โโโ csv/ # static files used in docs โโโ images/ # images and screenshots โโโ json/ # theme translation files โโโ PO/ โโโ diataxis-templates/ # templates for contributing to our documentation โโโ docs # narrative documentation โโโ api-docs/ โโโ bigcommerce-for-wordpress/ โโโ legacy/ # Blueprint and V2 API docs โโโ msf/ # MSF docs โโโ partner-apps/ # docs for some partner integrations โโโ stencil-docs/ โโโ examples # example data for Stencil Handlebars context objects โโโ models # JSON schemas in YAML โโโ _root # YAML schemas for root Stencil Handlebars context objects โโโ ... โโโ reference/ # OpenAPI specification files โโโ catalog/ # catalog OAS API reference โโโ payments/ # payments OAS API reference โโโ ... # other OAS API reference โโโ theme-styles โโโ _root # MDX files for Stencil style configuration options โโโ .cspell.json โโโ .eslintrc.json # config for MDX linter โโโ .gitignore # gitignore โโโ .nojekyll โโโ .nvmrc # config for NVM โโโ .spectral.yaml # config for OAS linter โโโ CODE_OF_CONDUCT.md # Code of Conduct for participants โโโ CONTRIBUTING.md # guidelines for contribution โโโ package-lock.json โโโ package.json โโโ pull_request_template.md # template for most pull requests โโโ README.md View our archived documentation here.
