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.