Skip to content

The open source docs home for BigCommerce, including API specifications in OAS YAML and narrative docs in MDX

Notifications You must be signed in to change notification settings

bigcommerce/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

90f4cf2 Β· Jan 16, 2025
Sep 26, 2024
Oct 18, 2024
Aug 28, 2023
Oct 10, 2024
Aug 7, 2024
Dec 2, 2024
Jan 16, 2025
Mar 10, 2023
Aug 12, 2024
Jun 12, 2024
Jan 15, 2025
Aug 28, 2023
Mar 10, 2023
Feb 7, 2023
Dec 15, 2019
May 30, 2023
May 6, 2024
Nov 10, 2023
Oct 7, 2024
Dec 2, 2024
Nov 2, 2024
Dec 26, 2023
Jun 12, 2024
Dec 26, 2023

Repository files navigation

bcdevs logo

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:

πŸ‘‰ 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/
β”œβ”€β”€ 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

Archived docs

View our archived documentation here.


Our developer channels:

About

The open source docs home for BigCommerce, including API specifications in OAS YAML and narrative docs in MDX

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages