From 0374af34c06d19778cd2655640cfaa1ee35cde8f Mon Sep 17 00:00:00 2001
From: enigmalea <73132777+enigmalea@users.noreply.github.com>
Date: Wed, 27 Dec 2023 18:55:08 -0500
Subject: [PATCH] updates readme. (#91)
---
README.md | 88 ++++++++++++++++++++++++++++++++++++++++++++++---------
1 file changed, 74 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
index f0f6153..79a68b3 100644
--- a/README.md
+++ b/README.md
@@ -1,45 +1,105 @@
-# BobaDocs
+# 
boba-docs
-A monorepo containing the documentation for [BobaBoard](https://www.bobaboard.com), as well as some docusaurus plugins
-we use to pull some of our data directly from our [GitHub organization](https://github.com/BobaBoard).
+
-The monorepo aspect is managed through [Turborepo](https://turbo.build/), with yarn workspaces handling each "sub-package".
+
+
+
+[](https://github.com/BobaBoard/boba-docs/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
-> 📝 **NOTE:** Turborepo is not compatible with native Windows. Windows users will need to install WSL to edit the documentation. For more information on installing WSL see [The BobaBoard Guide to Installing WSL](https://docs.bobaboard.com/docs/development/start-developing/wsl).
+
-## How to run
+## BobaBoard
+
+BobaBoard is a modern, open source community-building software that draws
+inspiration from old-school forums for functionality and from modern social
+media for its style of interaction. It prioritizes privacy and fluidity of
+identity for users within communities and allows high levels of customization
+and fine-grained permission settings for users, community managers, and instance
+owners. The unique UX encourages creative expression across different formats,
+styles of communication, and community building.
+
+You can find out more about BobaBoard in general on our
+[website](https://www.bobaboard.com) and as a project by visiting our
+[project guide](https://docs.bobaboard.com/docs/project/intro).
+
+## This Repo
+
+
+
+
+
+
+boba-docs is a monorepo containing the documentation for
+[BobaBoard](https://www.bobaboard.com), as well as some docusaurus plugins we
+use to pull some of our data directly from our
+[GitHub organization](https://github.com/BobaBoard).
+
+The monorepo aspect is managed through [Turborepo](https://turbo.build/) with
+yarn workspaces handling each "sub-package".
+
+## Local Development
+
+> 📝 **NOTE:** Turborepo is not compatible with native Windows. Windows users
+> will need to install WSL to edit the documentation. For more information on
+> installing WSL see
+> [The BobaBoard Guide to Installing WSL](https://docs.bobaboard.com/docs/engineering/start-developing/wsl).
+
+### How to run
```
yarn install
yarn run start
```
-## Workspaces
+### Workspaces
We currently have 2 groups of workspaces:
- **docusaurus/**: contains our docusaurus installation
-- **plugins/\***: contains a subfolder for each docusaurus plugin maintained as part of this monorepo
+- **plugins/\***: contains a subfolder for each docusaurus plugin maintained as
+ part of this monorepo
-## How to install packages in a specific workspace
+### How to install packages in a specific workspace
Choose your poison:
-### Install packages through yarn workspace (from `root`)
+#### Install packages through yarn workspace (from `root`)
-This is similar to running `yarn add`, but slightly longer: `yarn workspace [workspacename-name] add`.
+This is similar to running `yarn add`, but slightly longer:
+`yarn workspace [workspacename-name] add`.
For example, you can run: `yarn workspace docusaurus add @package/name`.
-Documentation is on the [Turborepo website](https://turbo.build/repo/docs/handbook/package-installation).
+Documentation is on the
+[Turborepo website](https://turbo.build/repo/docs/handbook/package-installation).
-### Install packages from within the workspace
+#### Install packages from within the workspace
Run the regular `yarn add` command from within the workspace folder
```
cd workspace/folder
-yarn add @package/name`
+yarn add @package/name
```
Remember to still run `yarn run start` from the root directory.
+
+## Contributing
+
+> [!Important]
+> Our issue tracker is not up-to-date and we are specifically looking for people to help us wrangle issues into order. If you're very eager to start working, please contact us through our [tech form](https://docs.google.com/forms/d/e/1FAIpQLSdCX2_fZgIYX0PXeCAA-pfQrcLw_lSp2clGHTt3uBTWgnwVSw/viewform) (for coding) or our [non-tech form](https://forms.gle/Z44UreTxnbvFnoqc9) (for issue wrangling).
+
+BobaBoard welcomes one-time contributions. Our volunteer
+[Code of Conduct](https://docs.bobaboard.com/docs/volunteering/experience/code-of-conduct)
+applies in all of our social spaces, including Github Discussions or when
+commenting on issues or pull requests.
+
+We are also always looking for long-term volunteers to help with coding,
+documentation, and other efforts. If you'd like to become a BobaBoard volunteer,
+please see the
+[Volunteering Guide](https://docs.bobaboard.com/docs/volunteering) for details.
+
+## License
+
+