diff --git a/.changeset/six-buckets-grab.md b/.changeset/six-buckets-grab.md new file mode 100644 index 0000000000..e355e59da3 --- /dev/null +++ b/.changeset/six-buckets-grab.md @@ -0,0 +1,6 @@ +--- +"@stackoverflow/stacks": patch +"@stackoverflow/stacks-docs": patch +--- + +chore(docs): add readme for each workspace diff --git a/packages/stacks-classic/README.md b/packages/stacks-classic/README.md new file mode 100644 index 0000000000..2a394db5ae --- /dev/null +++ b/packages/stacks-classic/README.md @@ -0,0 +1,24 @@ +# Stacks + +[![ci status][gh-action-badge]][gh-action-url] [![npm version][npm-badge]][npm-url] + +Stacks is Stack Overflow’s design system. It includes the resources needed to create consistent, predictable interfaces and workflows that conform to Stack Overflow’s principles, design language, and best practices. + +Our documentation is built with Stacks itself, using its [immutable, atomic classes](http://johnpolacek.com/rethinking/) and components. + +The [Stacks website](https://stackoverflow.design/) documents: + +## Product +- Semantic and accessible component markup +- Cross-browser compatible Less / CSS +- An [icon library](https://github.com/StackExchange/Stacks-Icons) + +## Email +- Email templates & components + +# Using Stacks +Using Stacks is outlined in our [usage guidelines](https://stackoverflow.design/product/develop/using-stacks). + +## Migrating from v1 to v2 + +To migrate from Stacks v1 to v2, see our [migration guide](/MIGRATION_GUIDE.md). \ No newline at end of file diff --git a/packages/stacks-docs/README.md b/packages/stacks-docs/README.md new file mode 100644 index 0000000000..ebdc8addd8 --- /dev/null +++ b/packages/stacks-docs/README.md @@ -0,0 +1,15 @@ +# Stacks Docs + +This workspace contains the Stacks documentation project that’s hosted on: https://stackoverflow.design/ + +To contribute to Stacks documentation you can build locally via: +```sh +npm start +``` +This command will pull up the local dev server at http://localhost:8080. You can also view our [building guidelines](https://stackoverflow.design/product/develop/building). + +# Release management +Refer to the main [README.md](../../README.md) for details on how releases are currently managed. + +# Bugs and feature requests +Have a bug or feature request? First search existing or closed issues to make sure the issue hasn’t been noted yet. If not, review our [issue guidelines](../../CONTRIBUTING.md#open-an-issue) for submitting [a bug report](../../CONTRIBUTING.md#reporting-bugs) or [feature request](../../CONTRIBUTING.md#feature-requests). \ No newline at end of file