Skip to content

Latest commit

 

History

History
65 lines (39 loc) · 2.75 KB

README.md

File metadata and controls

65 lines (39 loc) · 2.75 KB
Raw

RaidGuild Handbook

Welcome to the RaidGuild Handbook repository! This handbook serves as the central knowledge base for RaidGuild, detailing guild operations, project practices, DAO governance, and community standards. The Handbook is structured to help both new and veteran members navigate the guild’s unique systems, terminology, and tools. Here, you’ll find documentation on topics like setting up escrows, handling raid payments, DAO participation, and contributing to our decentralized organization.

About This Repository

This site is powered by Docusaurus 2, 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.

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.

  3. Prioritize Accuracy and Relevance
    Only include up-to-date and relevant information. Avoid unnecessary details that could complicate the guide or cause confusion.

  4. Propose and Discuss Major Changes
    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 for guild-specific terms.

Getting Started

Installation

Install dependencies with Yarn:

$ yarn

Local Development

Start a local development server with:

$ yarn 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.

Build

Generate the static content in the build directory:

$ yarn build

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

Deployment

  • Merge your feature/fix branch into master.
  • Merge master into production.

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

Thank you for contributing to the RaidGuild Handbook and helping us document and share the knowledge that strengthens our guild!