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
50 changes: 0 additions & 50 deletions .eslintrc.json

This file was deleted.

7 changes: 3 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,9 @@

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local
.env
Comment thread
ECWireless marked this conversation as resolved.
.env.*
!.env.example

npm-debug.log*
yarn-debug.log*
Expand Down
36 changes: 24 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ Welcome to the RaidGuild Handbook repository! This handbook serves as the centra

## About This Repository

This site is powered by [Docusaurus 2](https://v2.docusaurus.io/), a modern static site generator that makes it easy to build and maintain a knowledge base. Updates to the handbook are collaborative and welcome from all members of the guild. Contributions can range from correcting outdated information, enhancing documentation, adding new sections, or improving the clarity and readability of the content.
This site is powered by [Docusaurus 3](https://docusaurus.io/), a modern static site generator that makes it easy to build and maintain a knowledge base. The site configuration, sidebar, and custom pages are written in TypeScript. Updates to the handbook are collaborative and welcome from all members of the guild. Contributions can range from correcting outdated information, enhancing documentation, adding new sections, or improving the clarity and readability of the content.

## Best Practices for Contributing

1. **Familiarize Yourself with Handbook Standards**
Review the handbook to understand its tone, style, and structure. Each entry should be clear, accurate, and aligned with the guild’s mission and terminology.

2. **Use Clear and Accessible Language**
Avoid excessive jargon or complex explanations. The handbook should be approachable for readers at all levels of familiarity with RaidGuild.

Expand All @@ -21,24 +21,28 @@ This site is powered by [Docusaurus 2](https://v2.docusaurus.io/), a modern stat
For significant updates or additions, please create an issue first to discuss with other contributors. This ensures all changes align with guild practices and benefit the community.

5. **Check for Consistency**
Maintain consistency in terminology, formatting, and section structure to ensure a cohesive handbook. Refer to the [Glossary](docs/glossary.md) for guild-specific terms.
Maintain consistency in terminology, formatting, and section structure to ensure a cohesive handbook. Refer to the [Glossary](docs/resources/glossary.md) for guild-specific terms.

## Getting Started

### Installation
### Prerequisites

- Node.js 24
- [Corepack](https://nodejs.org/api/corepack.html), which installs the pinned pnpm version

Install dependencies with Yarn:
Enable Corepack and install dependencies:

```bash
$ yarn
corepack enable
pnpm install
```

### Local Development

Start a local development server with:

```bash
$ yarn start
pnpm start
```

This will open a browser window with the local site. Most changes are live-reloaded, so you can see updates without restarting the server.
Expand All @@ -48,18 +52,26 @@ This will open a browser window with the local site. Most changes are live-reloa
Generate the static content in the `build` directory:

```bash
$ yarn build
pnpm build
```

This output can be hosted on any static content hosting service.

### Quality Checks

Run formatting, linting, TypeScript, and production-build checks together:

```bash
pnpm check
```

### Deployment

- Merge your `feature/fix` branch into `master`.
- Merge `master` into `production`.
- Open a pull request from your conventional branch (for example, `feat/...`, `fix/...`, or `docs/...`) into `main`.
- Merge the pull request after all quality checks pass.

The handbook is deployed automatically by Vercel whenever changes are merged into `production`.
The handbook is deployed automatically by Vercel whenever changes are merged into `main`.

---

Thank you for contributing to the RaidGuild Handbook and helping us document and share the knowledge that strengthens our guild!
Thank you for contributing to the RaidGuild Handbook and helping us document and share the knowledge that strengthens our guild!
2 changes: 1 addition & 1 deletion docs/dao-operations/rips.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To improve transparency and accountability, we use an escrow system where the DA

## Escrow Options

For RIP projects, we leverage [SmartInvoice](https://app.smartinvoice.xyz) from within [Dungeon Master](https:dm.raidguild.org). The recommended solution is to have [Ganggang](/docs/dao-operations/dao-roles.md#ganggang---quality-assurance-group) be the client (or release address)
For RIP projects, we leverage [SmartInvoice](https://app.smartinvoice.xyz) from within [Dungeon Master](https://dm.raidguild.org). The recommended solution is to have [Ganggang](/docs/dao-operations/dao-roles#ganggang---quality-assurance-delegates) be the client (or release address)

- DAO co-signature for fund releases
- DAO control over funds, with the ability to withdraw if needed
Expand Down
75 changes: 0 additions & 75 deletions docusaurus.config.js

This file was deleted.

56 changes: 56 additions & 0 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
import type { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";

const config: Config = {
title: "RaidGuild Handbook",
tagline: "Your guide to Raiding with the RaidGuild",
url: "https://handbook.raidguild.org",
baseUrl: "/",
favicon: "img/rg-icon.png",
staticDirectories: ["static"],
organizationName: "raid-guild",
projectName: "handbook",
onBrokenLinks: "throw",
onBrokenAnchors: "throw",
markdown: {
hooks: {
onBrokenMarkdownLinks: "throw",
},
},
themeConfig: {
navbar: {
title: "RaidGuild",
logo: {
alt: "RaidGuild Logo",
src: "img/rg-icon.png",
},
items: [
{
href: "https://raidguild.org",
label: "Dot Org",
position: "right",
},
],
},
footer: {
style: "dark",
copyright: `Copyright © ${new Date().getFullYear()} RaidGuild`,
},
} satisfies Preset.ThemeConfig,
presets: [
[
"classic",
{
docs: {
sidebarPath: "./sidebars.ts",
editUrl: "https://github.com/raid-guild/handbook/edit/main/",
},
theme: {
customCss: "./src/css/custom.css",
},
} satisfies Preset.Options,
],
],
};

export default config;
31 changes: 31 additions & 0 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import eslint from "@eslint/js";
import eslintConfigPrettier from "eslint-config-prettier/flat";
import react from "eslint-plugin-react";
import reactHooks from "eslint-plugin-react-hooks";
import tseslint from "typescript-eslint";

export default tseslint.config(
{
ignores: [".docusaurus/**", "build/**", "node_modules/**", "static/**"],
},
eslint.configs.recommended,
...tseslint.configs.recommended,
{
files: ["**/*.{ts,tsx}"],
...react.configs.flat.recommended,
settings: {
react: {
version: "detect",
},
},
rules: {
"react/react-in-jsx-scope": "off",
"react/prop-types": "off",
},
},
{
files: ["**/*.{ts,tsx}"],
...reactHooks.configs.flat["recommended-latest"],
},
eslintConfigPrettier,
);
Loading