From c36a5bfbc98d2a09338319a299065506dcae32e3 Mon Sep 17 00:00:00 2001 From: Sarah Riehl Date: Wed, 27 Dec 2023 12:09:50 -0600 Subject: [PATCH] update readme --- README.md | 33 ++++----------------------------- 1 file changed, 4 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index e40852fe2..328caa244 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,9 @@ # BigCommerce API Specifications -This repo contains the OpenAPI Specifications (OAS) and JSON schema that form the human-readable [BigCommerce REST API Reference](https://developer.bigcommerce.com/docs/api). +**As of December 27, 2023, you can find all the public BigCommerce DevDocs at [https://github.com/bigcommerce/docs](https://github.com/bigcommerce/docs)!** -As of August 22, 2022, all API specification files are in OAS 3+ format. We also made significant changes to this repo in March 2023. Please update your fork to ensure you're working with the newest source files. +This repository is archived and read only. The final commit has been tagged. -## Contributing +If you maintain API clients, the new [bigcommerce/docs](https://github.com/bigcommerce/docs) repo is now your source for the most up-to-date API specifications. -If you're interested in contributing, see [CONTRIBUTING.md](CONTRIBUTING.md). - -## Directory structure - -```shell -. -├── .github/ # github config - └── workflows/ # workflows to lint pull requests, etc. -├── .idea/ # directory ignored by git - use for yourself -├── models/ # yml schema for various objects - ├── email_templates/ # email template schemas - ├── webhooks/ # webhooks schemas - └── json2schema.py # script to convert json to yml -├── reference/ # openapi specification files - ├── catalog/ # catalog OAS API reference - ├── payments/ # payments OAS API reference - └── ... # other OAS API reference -├── .eslintrc.json # config for MDX linter -├── .gitignore # gitignore -├── .spectral.yaml # config for OAS linter -├── CONTRIBUTING # guidelines for contribution -├── package-lock.json -├── package.json -├── pull_request_template.md # template for most pull requests -└── README -``` +This consolidation lets the BigCommerce DX team offer a more streamlined developer experience. [issues](https://github.com/bigcommerce/docs/issues), [discussions](https://github.com/bigcommerce/docs/discussions), and [pull requests](https://github.com/bigcommerce/docs/pulls) at [bigcommerce/docs](https://github.com/bigcommerce/docs)!