Skip to content

Commit aed3725

Browse files
authored
chore(docs): add readme for each workspace (#1982)
* add readme's for each package * Create six-buckets-grab.md * adjust stacks classic readme a bit
1 parent 0263465 commit aed3725

File tree

3 files changed

+45
-0
lines changed

3 files changed

+45
-0
lines changed

.changeset/six-buckets-grab.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"@stackoverflow/stacks": patch
3+
"@stackoverflow/stacks-docs": patch
4+
---
5+
6+
chore(docs): add readme for each workspace

packages/stacks-classic/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Stacks
2+
3+
[![ci status][gh-action-badge]][gh-action-url] [![npm version][npm-badge]][npm-url]
4+
5+
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.
6+
7+
Our documentation is built with Stacks itself, using its [immutable, atomic classes](http://johnpolacek.com/rethinking/) and components.
8+
9+
The [Stacks website](https://stackoverflow.design/) documents:
10+
11+
## Product
12+
- Semantic and accessible component markup
13+
- Cross-browser compatible Less / CSS
14+
- An [icon library](https://github.com/StackExchange/Stacks-Icons)
15+
16+
## Email
17+
- Email templates & components
18+
19+
# Using Stacks
20+
Using Stacks is outlined in our [usage guidelines](https://stackoverflow.design/product/develop/using-stacks).
21+
22+
## Migrating from v1 to v2
23+
24+
To migrate from Stacks v1 to v2, see our [migration guide](/MIGRATION_GUIDE.md).

packages/stacks-docs/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Stacks Docs
2+
3+
This workspace contains the Stacks documentation project that’s hosted on: https://stackoverflow.design/
4+
5+
To contribute to Stacks documentation you can build locally via:
6+
```sh
7+
npm start
8+
```
9+
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).
10+
11+
# Release management
12+
Refer to the main [README.md](../../README.md) for details on how releases are currently managed.
13+
14+
# Bugs and feature requests
15+
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).

0 commit comments

Comments
 (0)