Skip to content

Commit 8b605c5

Browse files
laurakalbaglaurakalbag
authored
Update docs readme (#107)
* Update readme title and commands info * Start adding CoC and contributing info * Add code of conduct and contribution guidelines to docs repo Closes issue #70 * Update readme with links to CoC and contribution guide
1 parent fa8d754 commit 8b605c5

File tree

3 files changed

+193
-23
lines changed

3 files changed

+193
-23
lines changed

‎CODE_OF_CONDUCT.md

+131
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at **[email protected]**.
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series of
85+
actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or permanent
92+
ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within the
112+
community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.1, available at
118+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
119+
120+
Community Impact Guidelines were inspired by
121+
[Mozilla's code of conduct enforcement ladder][mozilla coc].
122+
123+
For answers to common questions about this code of conduct, see the FAQ at
124+
[https://www.contributor-covenant.org/faq][faq]. Translations are available at
125+
[https://www.contributor-covenant.org/translations][translations].
126+
127+
[homepage]: https://www.contributor-covenant.org
128+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
129+
[mozilla coc]: https://github.com/mozilla/diversity
130+
[faq]: https://www.contributor-covenant.org/faq
131+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to the Stately Studio and XState docs! We really appreciate contributors like you, and we welcome any contributions to the documentation and code base.
4+
5+
There are a number of ways you can contribute to XState and Stately Studio:
6+
7+
- 📥 [Submit an issue](#submit-an-issue)
8+
- 🖊️ [Solve an issue or make a change](#making-changes)
9+
- 🛟 [Respond to questions in the Help channel on Discord](https://discord.gg/xstate)
10+
11+
Please read [our code of conduct](https://github.com/statelyai/docs/blob/main/CODE_OF_CONDUCT.md).
12+
13+
## Styleguide
14+
15+
We have a [Stately Guide to Writing Docs](https://github.com/statelyai/docs/wiki) to give you guidance on [how the docs are structured](https://github.com/statelyai/docs/wiki/Site-structure), [how to use special content types](https://github.com/statelyai/docs/wiki/Types-of-content), and how to write clear and useful docs!
16+
17+
## Making changes
18+
19+
Pull requests are encouraged. If you want to add documentation or fix a bug:
20+
21+
1. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) and [clone](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) the [repository](https://github.com/statelyai/xstate).
22+
2. [Create a separate branch](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/managing-branches) for your changes.
23+
3. Make your changes, and ensure that it is formatted by [Prettier](https://prettier.io).
24+
4. Run `yarn build` and ensure no links are broken.
25+
5. Push your branch and open a PR 🚀
26+
27+
PRs are reviewed promptly and merged in within a week or two (or even within one day), if everything looks good.
28+
29+
## Submit an issue
30+
31+
Issues and bug reports are also encouraged. If you want to submit an issue:
32+
33+
1. Search [existing issues](https://github.com/statelyai/xstate/issues) to check if your issue already exists or has been solved.
34+
2. [Create a new issue](https://github.com/statelyai/xstate/issues/new/choose) if your issue has not yet been submitted.
35+
3. Ensure you fill out all the details in the issue template to help us understand the issue.
36+
37+
We’ll try to respond promptly and address your issue as soon as possible.
38+
39+
## Stately Studio feature requests
40+
41+
Please post Stately Studio feature requests to [feedback.stately.ai](https://feedback.stately.ai). There, you can:
42+
43+
- 🔎 Search for existing feature requests,
44+
- ➕ Add new feature requests
45+
- 💬 Provide feedback
46+
- 🆕 Check out our changelog
47+
- 🗺️ View the public roadmap
48+
- 🗳️ Vote on proposed features, and more!

‎README.md

+14-23
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,35 @@
1-
# Website
1+
# Welcome to the Stately docs for Stately Studio and XState
22

3-
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
3+
Our docs are built using [Docusaurus 2](https://docusaurus.io/).
44

5-
### Installation
5+
We welcome any contributions to the documentation and code base.
6+
7+
- ✨ [Contribution guide](https://github.com/statelyai/xstate/blob/main/CONTRIBUTING.md)
8+
- 🖊️ [The Stately Guide to Writing Docs](https://github.com/statelyai/docs/wiki)
9+
- 🙋 [Code of conduct](https://github.com/statelyai/docs/blob/main/CODE_OF_CONDUCT.md)
10+
11+
## Installation
612

7-
1.
813
```
914
$ yarn
1015
```
1116

12-
2. Copy the contents of the `.env file for docusaurus` from 1Password into a `.env` file in the root of the folder.
13-
14-
### Local Development
17+
## Local development
1518

1619
```
1720
$ yarn start
1821
```
1922

2023
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
2124

22-
### Build
25+
## Build
2326

2427
```
2528
$ yarn build
2629
```
2730

28-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
31+
This command generates static content into the `build` directory.
2932

30-
### Deployment
31-
32-
Using SSH:
33-
34-
```
35-
$ USE_SSH=true yarn deploy
36-
```
37-
38-
Not using SSH:
39-
40-
```
41-
$ GIT_USER=<Your GitHub username> yarn deploy
42-
```
33+
## Deployment
4334

44-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
35+
The docs are built and deployed when merged into `main`.

0 commit comments

Comments
 (0)