diff --git a/README.md b/README.md index 843a8a1a0..83ab0806a 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,54 @@ -# BigCommerce public developer documentation +

+ bcdevs logo +

BigCommerce developer documentation

+

-This repo is the source of truth for the public, open source BigCommerce DevDocs 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. +You've found the BigCommerce documentation GitHub repository, which contains the public content for the [BigCommerce Developer Center](https://developer.bigcommerce.com/docs). + +This 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. The 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)! +--- + ## 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](/CONTRIBUTING.md) guide: -If you're interested in contributing, see our [Contribution guide](CONTRIBUTING.md) and [Code of conduct](CODE_OF_CONDUCT.md). +- [Making a Quick Edit](/CONTRIBUTING.md#making-a-quick-edit) +- [Editing Locally](/CONTRIBUTING.md#editing-locally) +- [Commit Messages](/CONTRIBUTING.md/cod#commit-messages) +- [Style Guides](/CONTRIBUTING.md#style-guides) +- [Contributing to Other Projects](/CONTRIBUTING.md#contributing-to-other-projects) -## History +### 👉 To discuss something +- Start a [Discussion](https://github.com/bigcommerce/docs/discussions). Our DevDocs team monitors GitHub Discussions regularly. -On December 27, 2023, the following public documentation repositories were deprecated, and all documentation moved into this repository. We retained the `git` history of each document using the `--allow-unrelated-histories` flag. The following repositories are now read-only: +### 👉 To report a bug or an issue you've encountered +- Open a new [Issue](https://github.com/bigcommerce/docs/issues). Our DevDocs team monitors GitHub Issues regularly. -* `https://github.com/bigcommerce/api-specs` -* `https://github.com/bigcommerce/dev-docs` -* `https://github.com/bigcommerce/theme-context-object-schemas` +
-### API specifications +*For more information, see our [Contribution Guidelines](./CONTRIBUTING.md) and [Code of conduct](./CODE_OF_CONDUCT.md).* + +--- + +## API specifications If you maintain API clients, this repository is your source for the most up-to-date public API specifications. -Please keep your fork up to date to ensure you're working with the newest source files. +Always update your fork to ensure you're working with the newest source files. -Significant dates include the following: + + -