Merge pull request #16 from m1sk9/feat/add-docs

docs: Add LunaticChat docs

7 files changed, 280 insertions, 6 deletions

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..2ff10db
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,25 @@
+# LunaticChat Contribution Guidelines
+
+## Looking for Support?
+
+For instructions on using LunaticChat, see the [official documentation](https://lc.m1sk9.dev).
+
+For questions, see the [discussion](https://github.com/m1sk9/LunaticChat/discussions).
+
+## Reporting Bugs / Requesting Features
+
+Before reporting a bug or requesting a feature, please search the [issues]().
+
+If your issue is not already reported, please create a new issue using the provided template. Be sure to include as much detail as possible, including steps to reproduce the issue if applicable.
+
+## Contributing Code
+
+We welcome contributions to LunaticChat!
+
+LuckPerms adheres to the [Kotlin Coding Conventions](https://kotlinlang.org/docs/coding-conventions.html).
+
+It also uses Ktlint. Merging pull requests into the main branch requires passing Ktlint checks. When submitting a pull request, remember to run `./gradlew ktlintFormat`.
+
+When making major changes that break backward compatibility, please discuss them beforehand via an issue or discussion.
+Such changes often cause confusion when made without prior discussion.
+
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000..3c194d2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,102 @@
+name: Bug Report
+description: Report a bug or unexpected behavior in LunaticChat
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to report a bug! Please fill out the information below to help us fix the issue.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Bug Description
+      description: A clear and concise description of what the bug is.
+      placeholder: Describe the bug you encountered...
+    validations:
+      required: true
+
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: Steps to Reproduce
+      description: Steps to reproduce the behavior
+      placeholder: |
+        1. Run command '...'
+        2. Send message '...'
+        3. See error
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected Behavior
+      description: What you expected to happen
+      placeholder: Describe what you expected to happen...
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual-behavior
+    attributes:
+      label: Actual Behavior
+      description: What actually happened
+      placeholder: Describe what actually happened...
+    validations:
+      required: true
+
+  - type: input
+    id: plugin-version
+    attributes:
+      label: LunaticChat Version
+      description: What version of LunaticChat are you using?
+      placeholder: "e.g., v0.1.0"
+    validations:
+      required: true
+
+  - type: input
+    id: minecraft-version
+    attributes:
+      label: Minecraft Version
+      description: What version of Minecraft are you running?
+      placeholder: "e.g., 1.21.4"
+    validations:
+      required: true
+
+  - type: input
+    id: paper-version
+    attributes:
+      label: Paper Version
+      description: What version of Paper are you using?
+      placeholder: "e.g., Paper-1.21.4-123"
+    validations:
+      required: true
+
+  - type: input
+    id: java-version
+    attributes:
+      label: Java Version
+      description: What version of Java are you running?
+      placeholder: "e.g., Java 21"
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs and Error Messages
+      description: Please paste relevant logs or error messages here
+      placeholder: Paste your logs here...
+      render: shell
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Add any other context about the problem here (screenshots, related issues, etc.)
+      placeholder: Any additional information...
+    validations:
+      required: false
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..e0f1ad3
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: GitHub Discussions
+    url: https://github.com/m1sk9/LunaticChat/discussions
+    about: Ask questions and discuss ideas with the community
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 0000000..e27e3e6
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,55 @@
+name: Feature Request
+description: Suggest a new feature or enhancement for LunaticChat
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for suggesting a new feature! Please provide as much detail as possible.
+
+  - type: textarea
+    id: feature-description
+    attributes:
+      label: Feature Description
+      description: A clear and concise description of the feature you'd like to see
+      placeholder: Describe the feature you want...
+    validations:
+      required: true
+
+  - type: textarea
+    id: problem-use-case
+    attributes:
+      label: Problem / Use Case
+      description: What problem does this feature solve? What would you use this for?
+      placeholder: |
+        Is your feature request related to a problem? Please describe.
+        Example: "I'm always frustrated when..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: proposed-solution
+    attributes:
+      label: Proposed Solution
+      description: How would you like this feature to work?
+      placeholder: Describe how you envision this feature working...
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternative Solutions
+      description: Have you considered any alternative solutions or workarounds?
+      placeholder: Describe any alternative solutions you've considered...
+    validations:
+      required: false
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Add any other context, screenshots, or examples about the feature request here
+      placeholder: Any additional information...
+    validations:
+      required: false
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..fd86a4f
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,54 @@
+## Description
+
+<!-- Provide a clear and concise description of what this PR changes -->
+
+## Type of Change
+
+<!-- Check the relevant boxes -->
+
+- [ ] Bug fix (non-breaking change that fixes an issue)
+- [ ] New feature (non-breaking change that adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+- [ ] Refactoring / Code cleanup
+- [ ] Other (please describe):
+
+## Related Issues
+
+<!-- Link any related issues here -->
+<!-- Example: Fixes #123, Relates to #456 -->
+
+Closes #
+
+## Testing
+
+<!-- Describe the testing you performed to verify your changes -->
+
+**Test Environment:**
+- Minecraft Version:
+- Paper Version:
+- Java Version:
+
+**Test Steps:**
+1.
+2.
+3.
+
+## Checklist
+
+<!-- Check all that apply -->
+
+- [ ] Code follows ktlint style guidelines (`./gradlew ktlintCheck`)
+- [ ] Build passes (`./gradlew build`)
+- [ ] Tested on Paper server
+- [ ] Updated documentation if needed
+- [ ] No breaking changes (or documented if necessary)
+- [ ] All new and existing tests pass
+
+## Screenshots / Logs (if applicable)
+
+<!-- Add any relevant screenshots or logs here -->
+
+## Additional Context
+
+<!-- Add any other context about the PR here -->
diff --git a/.github/SECURITY.md b/.github/SECURITY.md
new file mode 100644
index 0000000..b2a5b43
--- /dev/null
+++ b/.github/SECURITY.md
@@ -0,0 +1,16 @@
+# Security Policy
+
+## Supported Versions
+
+LunaticChat only supports the latest version at any given time.
+Older versions are not supported, and backports will not be provided unless absolutely necessary.
+
+### In Minecraft
+
+The Minecraft version follows the `api-version` on which the latest LunaticChat runs. However, it fundamentally depends on the Paper API / Velocity API version.
+
+(Example: If the `api-version` is `1.21`, operation on `1.21.X` is guaranteed.)
+
+## Reporting a Vulnerability
+
+Do not report security issues using Issues. Please report them by sending an encrypted email to [me@m1sk9.dev](mailto:me@m1sk9.dev).
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
index d706921..f5013d1 100644
--- a/.github/workflows/ci.yaml
+++ b/.github/workflows/ci.yaml
@@ -9,13 +9,8 @@ on:
       - main
 
 jobs:
-  build:
+  build_plugin:
     runs-on: ubuntu-24.04
-    permissions:
-      contents: read
-      pull-requests: write
-      issues: write
-
     steps:
       - name: Checkout repository
         uses: actions/checkout@v6
@@ -39,3 +34,25 @@ jobs:
           name: LunaticChat-${{ github.sha }}
           path: platform-paper/build/libs/*-all.jar
           retention-days: 7
+  build_docs:
+    runs-on: ubuntu-24.04
+    defaults:
+      run:
+        working-directory: "./docs"
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Setup Development Environment
+        uses: jdx/mise-action@v3
+        with:
+          working_directory: .
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Check lints
+        run: bun run lint
+
+      - name: Build documentation
+        run: bun run build