Documentation website

README.md

@@ -13,33 +13,6 @@ At the moment, Cyd supports the following platforms:
 
 Download the latest version of Cyd at [https://cyd.social/download/](https://cyd.social/download/).
 
-## Contribute to the Cyd open source project
+## Documentation
 
-### Code of Conduct
-
-All members of the Cyd community must agree to comply with our [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md).
-
-[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md) 
-
-### Legal stuff
-
-- Lockdown Systems LLC owns the copyright for Cyd.
-- Cyd is released under the [GNU General Public License v3](./LICENSE) license.
-- By contributing code to the project, you have agreed to the version of our [Contributor License Agreement](./CLA.md) that was in the `main` branch of the `lockdown-systems/cyd` GitHub repository at the time of your contribution.
-
-### Bugs and feature requests
-
-After reviewing existing [open issues](https://github.com/lockdown-systems/cyd/issues), you can report new issues on GitHub.
-
-- [Report a bug](https://github.com/lockdown-systems/cyd/issues/new?template=bug_report.md)
-- [Request a feature](https://github.com/lockdown-systems/cyd/issues/new?template=feature_request.md)
-
-### Security issues
-
-If you found a security bug, email security@lockdown.systems instead of reporting it on GitHub.
-
-### Writing code
-
-If you'd like to contribute code to Cyd, check out [Developing Cyd](./DEVELOPMENT.md) for instructions on setting up a local development environment.
-
-When you're ready to contribute code, open a pull request in the GitHub repository and one of the project maintainers will review it and possibly ask questions, request changes, reject it, or merge it into the project.
+Learn all about how to use Cyd, what features it has, and how to get involved in the open source project, including how to request features and report bugs, at the [Cyd Documentation](https://docs.cyd.social) website.

docs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docs/README.md

@@ -0,0 +1,25 @@
+# Cyd Docs Website
+
+The Cyd docs website is built using [Docusaurus](https://docusaurus.io/).
+
+### Installation
+
+```sh
+npm install
+```
+
+### Local Development
+
+```sh
+npm run start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```sh
+npm run build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.

docs/blog/2025-03-05-cyd-1.1.0.md

@@ -0,0 +1,15 @@
+---
+slug: cyd-1.1.0
+title: Cyd 1.1.0 released
+---
+
+**We're pleased to announce Cyd 1.1.0 is released.** This is a major release that fixes several bugs and adds support for, among other things, *migrating your tweets from X into Bluesky*! Here's what's new:
+
+- Major feature: You can now [migrate your tweets to Bluesky!](/docs/x/migrate-bluesky) ([#369](https://github.com/lockdown-systems/cyd/issues/369))
+- Major feature: Cyd now has [documentation](/docs/intro/) (that's this website you're reading now) ([#374](https://github.com/lockdown-systems/cyd/issues/374), [#412](https://github.com/lockdown-systems/cyd/pull/412))
+- Minor feature: New "Enable Clicking in Browser" while Cyd does its think with the embedded browser ([#435](https://github.com/lockdown-systems/cyd/pull/435))
+- Bug fix: When you import an X archive, or build your database from scratch, GIF media is handled correctly ([#421](https://github.com/lockdown-systems/cyd/pull/421))
+- Bug fix: Fix crash when importing certain tweets that contain links ([#432](https://github.com/lockdown-systems/cyd/issues/432))
+- Bug fix: Fix displaying names of direct message users in the X archive ([#416](https://github.com/lockdown-systems/cyd/issues/416))
+
+See the release on GitHub: https://github.com/lockdown-systems/cyd/releases/tag/v1.1.0

docs/docs/contributing/_category_.json

@@ -0,0 +1,8 @@
+{
+    "label": "Contributing to Cyd",
+    "position": 6,
+    "link": {
+        "type": "generated-index",
+        "description": "Get involved in the Cyd development community!"
+    }
+}

CODE_OF_CONDUCT.md → docs/docs/contributing/code-of-conduct.md

@@ -1,3 +1,7 @@
+---
+sidebar_position: 4
+title: Code of Conduct
+---
 
 # Contributor Covenant Code of Conduct
 
@@ -130,5 +134,4 @@ For answers to common questions about this code of conduct, see the FAQ at
 [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
 [Mozilla CoC]: https://github.com/mozilla/diversity
 [FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations
-
+[translations]: https://www.contributor-covenant.org/translations

CLA.md → docs/docs/contributing/contributor-license-agreement.md

@@ -1,3 +1,7 @@
+---
+sidebar_position: 5
+---
+
 # Contributor License Agreement
 
 Thank you for your interest in contributing to Lockdown Systems LLC's Cyd ("We" or "Us").

docs/docs/contributing/contributors.md

@@ -0,0 +1,36 @@
+---
+sidebar_position: 1
+---
+
+# For Contributors
+
+Thanks for your interest in contributing to Cyd! The source code and issue tracker are hosted on [GitHub](https://github.com/lockdown-systems/cyd).
+
+## Code of Conduct
+
+All members of the Cyd community must agree to comply with our [Contributor Covenant Code of Conduct](./code-of-conduct).
+
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](./code-of-conduct) 
+
+## Legal stuff
+
+- Lockdown Systems LLC owns the copyright for Cyd.
+- Cyd is released under the [GNU General Public License v3](https://github.com/lockdown-systems/cyd/blob/main/LICENSE) license.
+- By contributing code to the project, you have agreed to the version of our [Contributor License Agreement](./contributor-license-agreement) that was in the `main` branch of the `lockdown-systems/cyd` GitHub repository at the time of your contribution.
+
+## Bugs and feature requests
+
+After reviewing existing [open issues](https://github.com/lockdown-systems/cyd/issues), you can report new issues on GitHub.
+
+- [Report a bug](https://github.com/lockdown-systems/cyd/issues/new?template=bug_report.md)
+- [Request a feature](https://github.com/lockdown-systems/cyd/issues/new?template=feature_request.md)
+
+## Security issues
+
+If you found a security bug, email security@lockdown.systems instead of reporting it on GitHub.
+
+## Writing code
+
+If you'd like to contribute code to Cyd, check out [Developing Cyd](https://github.com/lockdown-systems/cyd/blob/main/DEVELOPMENT.md) for instructions on setting up a local development environment.
+
+When you're ready to contribute code, open a pull request in the GitHub repository and one of the project maintainers will review it and possibly ask questions, request changes, reject it, or merge it into the project.

DEVELOPMENT.md → docs/docs/contributing/developers.md

@@ -1,4 +1,8 @@
-# Developing Cyd
+---
+sidebar_position: 2
+---
+
+# For Developers
 
 Cyd is a desktop app for Windows, Mac, and Linux written in Node.js. To run Cyd locally, all you need is [Node.JS LTS](https://nodejs.org/en) for your operating systems.
 

docs/docs/contributing/testers.md

@@ -0,0 +1,73 @@
+---
+sidebar_position: 3
+---
+
+# For Testers
+
+This page is intended for people who are running the dev version of Cyd to help test it.
+
+:::info
+The dev version of Cyd uses a dev server which limits what email addresses are allowed to sign up for Cyd accounts. While anyone can download the dev version, you can only sign up for a test Premium plan if you've spoken a member of the Lockdown Systems Collective and we have agreed to let you test.
+:::
+
+## Accessing Premium features while testing
+
+Once you're signed into your dev Cyd account, you can sign up for Premium using the following test credit card:
+
+- Card number: `4242 4242 4242 4242`
+- Expiration date: anything in the future
+- Security code: make it up
+- Billing address: make it up
+
+## Download Cyd Dev
+
+### For Windows and Mac users
+
+Here's where to download the latest development release of Cyd:
+
+- macOS: https://dev-api.cyd.social/download?platform=macos
+- Windows x64: https://dev-api.cyd.social/download?platform=windows
+- Windows arm64: https://dev-api.cyd.social/download?platform=windows&arch=arm64
+
+### For Linux users
+
+Here are instructions for .deb repos:
+
+```sh
+# Import the signing key
+curl -fsSL https://releases.lockdown.systems/signing-key.asc | sudo gpg --dearmor -o /usr/share/keyrings/lockdown-systems-archive-keyring.gpg
+
+# Add the repository
+echo "deb [signed-by=/usr/share/keyrings/lockdown-systems-archive-keyring.gpg] https://releases.lockdown.systems/debian/ dev main" | sudo tee /etc/apt/sources.list.d/lockdown-systems.list
+
+# Install Cyd
+sudo apt update
+sudo apt install cyd
+```
+
+Here are instructions for .rpm repos:
+
+```sh
+# Import the signing key
+sudo rpm --import https://releases.lockdown.systems/signing-key.asc
+
+# Add the repository
+sudo tee /etc/yum.repos.d/lockdown-systems.repo <<EOF
+[lockdown-systems]
+name=Lockdown Systems Repository
+baseurl=https://releases.lockdown.systems/rpm/dev/
+enabled=1
+gpgcheck=1
+gpgkey=https://releases.lockdown.systems/signing-key.asc
+EOF
+
+# Install Cyd
+sudo dnf install cyd
+```
+
+If those don't work for you, you can download a zip file version here:
+
+- Linux (zip) x64: https://dev-api.cyd.social/download?platform=linux
+- Linux (zip) x64 PGP sig: https://dev-api.cyd.social/download?platform=linux&sig=true
+- Linux (zip) arm64: https://dev-api.cyd.social/download?platform=linux&arch=arm64
+- Linux (zip) arm64 PGP sig: https://dev-api.cyd.social/download?platform=linux&arch=arm64&sig=true

docs/docs/cyd-for-teams/_category_.json

@@ -0,0 +1,8 @@
+{
+    "label": "Cyd for Teams",
+    "position": 5,
+    "link": {
+        "type": "generated-index",
+        "description": "Give your employees privacy, peace of mind, and protection from doxing and harassment."
+    }
+}

docs/docs/cyd-for-teams/dashboard.md

@@ -0,0 +1,81 @@
+---
+sidebar_position: 3
+---
+
+# Teams Dashboard
+
+After creating an organization and purchasing seats, the Cyd for Teams dashboard looks like this:
+
+![The Cyd for Teams dashboard](./img/dashboard.png)
+
+If you want to use Cyd yourself, click **Add yourself**.
+
+## Manage Seats
+
+There are two ways to add new seats to your account. You can invite people using their email addresses, or you can add a domain name to your account, which is described [below](#add-your-domain-name).
+
+### Inviting People to Your Team
+
+To invite someone, under **Seat Invitations**, enter their email address and click **Invite**. This will create a seat invitation and email them a link they can use to join your Cyd team. After inviting someone, you can click **Copy Link** to copy the link to your clipboard, which lets you send it to them some other way.
+
+Seat invitations use up the number of seats you've paid for. If someone is not accepting a seat invitation, you can cancel their invitation to get the seat back.
+
+If you invite someone to your team who already has a Cyd account, it will automatically add them to your team rather than making them click a link.
+
+### Removing People From Your Team
+
+If you need to offboard a team member, find them under **Seats** and click **Delete**.
+
+This will recover their seat, which you are free to assign to someone else.
+
+## Manage Admins
+
+Admin users have the ability to add and delete seats, add and delete other admins, and update your subscription plan.
+
+Just like with seats, you can invite users to become admins using their email addresses. Admins can also delete admin access from other admins. Admins cannot remove admin privileges from organization owner.
+
+:::tip Admins don't take up seats
+
+Admin users don't necessarily need to use up one of the seats you're paying for too ‐ for example, if you work for a Managed Service Provider and provide IT support for your clients, you can have an admin user without your client having to pay for it.
+
+:::
+
+## Add Your Domain Name
+
+If you have many people on your team, it will likely be more convenient to add your organization's domain name and let your team sign up on their own. Cyd for Teams makes this easy.
+
+Under **Domains**, just add your domain name and click the **Add Domain** button.
+
+For example, if your organization's domain name is `example.com` and you add this domain, if `alice@example.com` email address signs into Cyd, she will automatically join your team and take up one seat.
+
+:::tip Onboarding and offboarding is easy
+
+If you add your domain to Cyd, all you have to do to onboard your employees is let them know they have free access to Cyd. When an employee leaves, you need to login to the Cyd for Teams dashboard and delete their seat. That's it.
+
+:::
+
+:::warning What happens when you run out of seats
+
+If someone signs up to Cyd using an email address with your organization's domain, but you don't have any seats available, the person won't get added to your team automatically.
+
+If you update your subscription to add more seats, you'll need to manually invite the user that was unable to automatically join your team.
+
+:::
+
+## Organization Settings
+
+Only organization owners can change organization settings. If you're the owner (the person who initally set it up), you can:
+
+- Change the name of your organization.
+- Change the owner of your organization to an existing admin. If you do this, you immediately lose the ability to change organization settings. The the new owner has this power now.
+
+## Email Notification Preferences
+
+Admins can choose to get notified by email:
+
+- When new seats are added to the organization
+- When all seats are filled
+
+## Invoices
+
+At the bottom of the Cyd for Teams dashboard, you can download all invoices that you've paid.

docs/docs/cyd-for-teams/intro.md

@@ -0,0 +1,11 @@
+---
+sidebar_position: 1
+---
+
+# What is Cyd for Teams?
+
+If you run a business or an organization and would like to give your employees privacy, peace of mind, and protection from doxing and harassment (*ehem*, newsrooms and non-profits, I'm looking at you), then Cyd for Teams is for you.
+
+Cyd for Teams gives you central management and billing of Premium plans for everyone at your organization. You can invite individual people to your plan, or you can allowlist a domain name so that anyone who signs up with an email address from your organization gets a Premium account automatically. Seats are transferrable, so if one employee leaves you can give that seat to the next person without needing to buy new seat.
+
+If you'd like to sign up for Cyd for Teams, see [Sign Up](./sign-up).

docs/docs/cyd-for-teams/sign-up.md

@@ -0,0 +1,15 @@
+---
+sidebar_position: 2
+---
+
+# Sign Up
+
+To sign up for Cyd for Teams, go to the [Cyd Dashboard](https://dash.cyd.social/) and sign up with an email address.
+
+Once you've loaded the Cyd Dashboard, click the **Cyd for Teams** link in the navigation bar at the top of the page. You will see a form for creating a new organization like this:
+
+![Create an organization](./img/create-org.png)
+
+Give your organization a name, choose the number of seats you would like to purchase (you can always increase or decrease this later on), and click the **Buy Now** button.
+
+And that's it! You've created an organization and purchased Cyd for Teams seats. See [Teams Dashboard](./dashboard) to learn how to manage your Cyd for Teams account.

docs/docs/getting-started/_category_.json

@@ -0,0 +1,8 @@
+{
+    "label": "Getting Started",
+    "position": 2,
+    "link": {
+        "type": "generated-index",
+        "description": "Get started using Cyd."
+    }
+}