BigCommerce developer documentation

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!

---

Contributing

Thanks for your interest in contributing to our documentation! Below are a few quick ways to get started:

👉 To make a change

Here are some quick links to our Contribution guide:

• Making a Quick Edit
• Editing Locally
• Commit Messages
• Style Guides
• Contributing to Other Projects

👉 To discuss something

• Start a Discussion. Our DevDocs team monitors GitHub Discussions regularly.

👉 To report a bug or an issue you've encountered

• Open a new Issue. Our DevDocs team monitors GitHub Issues regularly.

For more information, see our Contribution Guidelines and Code of conduct.

---

API specifications

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.

Directory structure

.
├── .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/                            
├── 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

Archived docs

View our archived documentation here.

---

Our developer channels:

• Join our Developer Slack space
• Read or contribute to our Resource Hub
• Follow us on X (Twitter) @BigCommerceDevs
• Follow the BigCommerce Developers Linkedin