{"id":19312117,"url":"https://github.com/bigcommerce/docs","last_synced_at":"2025-04-22T15:31:55.281Z","repository":{"id":211474067,"uuid":"598753608","full_name":"bigcommerce/docs","owner":"bigcommerce","description":"The open source docs home for BigCommerce, including API specifications in OAS YAML and narrative docs in MDX","archived":false,"fork":false,"pushed_at":"2025-04-16T15:11:05.000Z","size":53095,"stargazers_count":14,"open_issues_count":18,"forks_count":38,"subscribers_count":26,"default_branch":"main","last_synced_at":"2025-04-16T22:19:48.454Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://developer.bigcommerce.com","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bigcommerce.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-02-07T18:39:09.000Z","updated_at":"2025-04-16T15:11:09.000Z","dependencies_parsed_at":"2025-04-16T16:44:55.095Z","dependency_job_id":"181e20fc-f6bb-4359-9e38-4e337857d504","html_url":"https://github.com/bigcommerce/docs","commit_stats":null,"previous_names":["bigcommerce/docs"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigcommerce","download_url":"https://codeload.github.com/bigcommerce/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250267401,"owners_count":21402468,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T00:32:55.491Z","updated_at":"2025-04-22T15:31:55.269Z","avatar_url":"https://github.com/bigcommerce.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"bcdevs logo\" src=\"./assets/images/bcdevs-logo.png\" width=\"100px\" /\u003e\n  \u003ch1 align=\"center\"\u003eBigCommerce developer documentation\u003c/h1\u003e\n\u003c/p\u003e\n\nYou've found the BigCommerce documentation GitHub repository, which contains the public content for the [BigCommerce Developer Center](https://developer.bigcommerce.com/docs).\n\nThis repo is the source of truth for our public, open source documentation and API reference at [developer.bigcommerce.com](https://developer.bigcommerce.com). It consists of **Markdown React (.mdx)**, **OpenAPI Specification (.yml)**, and **JSON Schema (.json and .yml)** files.\n\nThe BigCommerce DX team maintains these open source docs; we welcome your [issues](https://github.com/bigcommerce/docs/issues), [discussions](https://github.com/bigcommerce/docs/discussions), and [pull requests](https://github.com/bigcommerce/docs/pulls)!\n\n---\n\n## Contributing\nThanks for your interest in contributing to our documentation! Below are a few quick ways to get started: \n\n### 👉 To make a change \nHere are some quick links to our [Contribution](/CONTRIBUTING.md) guide: \n\n- [Making a Quick Edit](/CONTRIBUTING.md#making-a-quick-edit)\n- [Editing Locally](/CONTRIBUTING.md#editing-locally)\n- [Commit Messages](/CONTRIBUTING.md/cod#commit-messages)\n- [Style Guides](/CONTRIBUTING.md#style-guides)\n- [Contributing to Other Projects](/CONTRIBUTING.md#contributing-to-other-projects)\n\n### 👉 To discuss something \n- Start a [Discussion](https://github.com/bigcommerce/docs/discussions). Our DevDocs team monitors GitHub Discussions regularly.\n\n### 👉 To report a bug or an issue you've encountered\n- Open a new [Issue](https://github.com/bigcommerce/docs/issues). Our DevDocs team monitors GitHub Issues regularly.\n\n\u003cbr/\u003e\n\n*For more information, see our [Contribution Guidelines](./CONTRIBUTING.md) and [Code of conduct](./CODE_OF_CONDUCT.md).*\n\n---\n\n## API specifications\n\nIf you maintain API clients, this repository is your source for the most up-to-date public API specifications.\n\nAlways update your fork to ensure you're working with the newest source files.\n\n\u003c!-- Significant dates include the following:\n\n* As of August 22, 2022, all API specification files are in OAS 3+ format.\n* In March 2023, we made significant changes to support a new OAS parser at [developer.bigcommerce.com](https://developer.bigcommerce.com).\n* In May 2023, we subdivided both the Catalog and Payments API specifications into multiple files.\n* On December 27, 2023, all public docs moved into the [bigcommerce/docs](https://github.com/bigcommerce/docs) repo. --\u003e\n\n\n## Directory structure\n\n```shell\n.\n├── .github/                           # github config\n    └── workflows/                     # workflows to lint pull requests, etc.\n    └── ...\n├── .idea/                             # directory ignored by git - use for yourself\n├── .style/                            # CSPELL data files\n├── assets/ \n    ├── csv/                           # static files used in docs\n    ├── images/                        # images and screenshots\n    ├── json/                          # theme translation files\n    └── PO/\n├── diataxis-templates/                # templates for contributing to our documentation                             \n├── docs                               # narrative documentation\n    ├── api-docs/                      \n    ├── bigcommerce-for-wordpress/     \n    ├── legacy/                        # Blueprint and V2 API docs\n    ├── msf/                           # MSF docs\n    ├── partner-apps/                  # docs for some partner integrations\n    └── stencil-docs/   \n├── examples                           # example data for Stencil Handlebars context objects\n├── models                             # JSON schemas in YAML\n    ├── _root                          # YAML schemas for root Stencil Handlebars context objects\n    ├── ...\n├── reference/                         # OpenAPI specification files\n    ├── catalog/                       # catalog OAS API reference\n    ├── payments/                      # payments OAS API reference\n    └── ...                            # other OAS API reference\n├── theme-styles          \n    ├── _root                          # MDX files for Stencil style configuration options\n├── .cspell.json  \n├── .eslintrc.json                     # config for MDX linter\n├── .gitignore                         # gitignore\n├── .nojekyll    \n├── .nvmrc                             # config for NVM\n├── .spectral.yaml                     # config for OAS linter\n├── CODE_OF_CONDUCT.md                 # Code of Conduct for participants\n├── CONTRIBUTING.md                    # guidelines for contribution\n├── package-lock.json                  \n├── package.json                       \n├── pull_request_template.md           # template for most pull requests\n└── README.md\n\n```\n\n## Archived docs \nView our archived documentation [here](/archive/). \n\n---\n## Our developer channels: \n* [Join our Developer Slack space](https://developer.bigcommerce.com/slack)\n* [Read or contribute to our Resource Hub](https://developer.bigcommerce.com/resource-hub)\n* [Follow us on X (Twitter) @BigCommerceDevs](https://twitter.com/BigCommerceDevs)\n* [Follow the BigCommerce Developers Linkedin](https://www.linkedin.com/showcase/bigcommercedevs/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigcommerce%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigcommerce%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigcommerce%2Fdocs/lists"}