Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

final, update readme #2124

Merged
merged 1 commit into from
Dec 27, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 3 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,7 @@
# BigCommerce Developer Documentation

This repository contains the markdown files and static assets powering [developer.bigcommerce.com](https://developer.bigcommerce.com/), which includes [API Docs](https://developer.bigcommerce.com/docs), [Theme Docs](https://developer.bigcommerce.com/stencil-docs), and [BigCommerce for WordPress](https://developer.bigcommerce.com/bigcommerce-for-wordpress/overview).
**As of December 27, 2023, you can find all the public BigCommerce DevDocs at [https://github.com/bigcommerce/docs](https://github.com/bigcommerce/docs)!**

This repository is archived and read only. The final commit has been tagged.

Other repositories that contain content that appears on [developer.bigcommerce.com](https://developer.bigcommerce.com/) include [theme-context-object-schemas](https://github.com/bigcommerce/theme-context-object-schemas/) for [Theme Objects](https://developer.bigcommerce.com/theme-objects) and [api-specs](https://github.com/bigcommerce/api-specs) for [API Reference](https://developer.bigcommerce.com/docs/api).

## Contributing

If you're interested in contributing to BigCommerce Developer Documentation, see [CONTRIBUTING.md](CONTRIBUTING.md).

## Directory Structure

```shell
.
├── .github/ # github config
└── workflows/ # workflows to lint pull requests, etc.
├── .notes/ # directory ignored by git - use for yourself
├── 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/ # theme docs
├── .eslintrc.json # config for MDX linter
├── .gitignore # gitignore
├── .nojekyll
├── .spelling
├── 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. We look forward to seeing your [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)!