Skip to content
Merged
Show file tree
Hide file tree
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
6 changes: 6 additions & 0 deletions .changeset/six-buckets-grab.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@stackoverflow/stacks": patch
"@stackoverflow/stacks-docs": patch
---

chore(docs): add readme for each workspace
24 changes: 24 additions & 0 deletions packages/stacks-classic/README.md
Original file line number Diff line number Diff line change
@@ -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).
15 changes: 15 additions & 0 deletions packages/stacks-docs/README.md
Original file line number Diff line number Diff line change
@@ -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).