diff --git a/sdocs-main-updated.zip b/sdocs-main-updated.zip new file mode 100644 index 0000000..6dc5ea6 Binary files /dev/null and b/sdocs-main-updated.zip differ diff --git a/sway-docs-integration-notes.md b/sway-docs-integration-notes.md new file mode 100644 index 0000000..d98add0 --- /dev/null +++ b/sway-docs-integration-notes.md @@ -0,0 +1,57 @@ +# Sway `/docs` Integration Notes + +Use `sway-docs-page.tsx` as the page content for `/docs`. + +The live site is a Next app. The legal pages are wrapped by an existing shell that renders: + +- `SidebarProvider` +- `LegalBodyClass` +- `AppSidebar` +- `SidebarTrigger` +- `Separator` +- `LegalHeader` +- a centered content panel with `max-w-6xl`, `rounded-2xl`, `border-white/10`, `bg-neutral-900/65`, `p-4`, and `sm:p-6` + +Do not paste this as standalone HTML. Put the page inside that same shell. + +If the current shell is only in `app/legal/layout.tsx`, move that layout unchanged into a route group so it can wrap both legal pages and docs without changing URLs: + +```txt +app/(document-shell)/layout.tsx +app/(document-shell)/docs/page.tsx +app/(document-shell)/legal/terms/page.tsx +app/(document-shell)/legal/privacy/page.tsx +app/(document-shell)/legal/cookies/page.tsx +app/(document-shell)/legal/security/page.tsx +``` + +Then copy `sway-docs-page.tsx` to: + +```txt +app/(document-shell)/docs/page.tsx +``` + +If `LegalHeader` has hardcoded breadcrumbs, add a `/docs` entry that renders the same breadcrumb style with: + +```txt +Home > Documentation +``` + +If `AppSidebar` has hardcoded navigation, add a `Documentation` item only if Sway wants `/docs` visible in the sidebar. Keep the existing Legal Center, Quick Links, icon sizing, active state, spacing, and muted text classes unchanged. + +Expected imports used by the page: + +```tsx +import Link from "next/link"; +import { BookOpenText, Flag } from "lucide-react"; +import { Badge } from "@/components/ui/badge"; +import { + Card, + CardContent, + CardDescription, + CardHeader, + CardTitle, +} from "@/components/ui/card"; +``` + +If the repo aliases differ, update only the import paths. The JSX and classes intentionally match the legal pages observed on the live site. diff --git a/sway-docs-page.tsx b/sway-docs-page.tsx new file mode 100644 index 0000000..1ecd4fc --- /dev/null +++ b/sway-docs-page.tsx @@ -0,0 +1,327 @@ +import Link from "next/link"; +import { BookOpenText, Flag } from "lucide-react"; + +import { Badge } from "@/components/ui/badge"; +import { + Card, + CardContent, + CardDescription, + CardHeader, + CardTitle, +} from "@/components/ui/card"; + +export const metadata = { + title: "Sway Bot Documentation", + description: + "Learn how to set up, configure, and manage Sway for your Roblox and Discord community.", +}; + +const cardClass = "border-white/10 bg-neutral-900/60 text-neutral-200"; +const descriptionClass = "text-neutral-200/55"; +const contentClass = "space-y-3 text-sm leading-6 text-neutral-200/75"; +const linkClass = "underline text-neutral-200"; + +export default function DocsPage() { + return ( +
+
+ + + Documentation + +

+ Sway Bot Documentation +

+

+ Learn how to set up, configure, and manage Sway for your Roblox and + Discord community. +

+
+ + + + 1. Introduction + + What Sway helps your community manage. + + + +

+ Sway is an all-in-one management platform for Roblox and Discord + communities. It helps teams manage verification, moderation, + activity tracking, staff workflows, and session operations from one + dashboard. +

+ + + + + + 2. Getting Started + + Connect Sway and confirm the first setup works. + + + +
    +
  • Invite Sway to your Discord server from the Sway dashboard.
    • +
  • + Open the dashboard and select the server you want to configure. +
    • +
  • + Confirm Sway has the permissions it needs for verification, + moderation, logging, and configured channels. +
    • +
  • + Enable verification and add clear instructions in the channel your + members will use. +
    • +
  • + Test the setup with a staff account before rolling it out to the + full community. +
    • +
+ + + + + + 3. Verification and Security + + Keep access trusted across Roblox and Discord. + + + +

+ Sway supports Roblox and Discord account verification so staff can + understand who is joining, what access they should receive, and + whether role checks are passing correctly. +

+
    +
  • Use account linking to connect Discord users with Roblox users.
    • +
  • Use role checks and access control to keep permissions clear.
    • +
  • + Review flagged or unusual users before taking action when possible. +
    • +
  • + Keep authentication limited to official provider login flows. +
    • +
  • + Use anti-abuse controls to reduce evasion, spam, and malicious + activity. +
    • +
+ + + + + + 4. Moderation and Safety + + Make enforcement consistent and accountable. + + + +

+ Sway provides moderation tools that help staff issue warnings, track + cases, review logs, and apply community rules consistently. +

+
    +
  • Use warnings and cases to keep moderation history organized.
    • +
  • Keep logs enabled so staff actions can be reviewed later.
    • +
  • + Limit moderation access to trusted roles with a clear reason to + use it. +
    • +
  • + Review enforcement patterns regularly to keep decisions fair and + consistent. +
    • +
+ + + + + + 5. Staff and Team Management + + Keep staff workflows visible as the team grows. + + + +

+ Sway helps teams manage promotions, infractions, rank changes, staff + oversight, and team organization from the dashboard. +

+
    +
  • Record promotions and rank changes with clear context.
    • +
  • Track infractions so staff history stays easy to review.
    • +
  • Use oversight tools to spot trends and support moderators.
    • +
  • + Keep staff roles and permissions organized as your community + changes. +
    • +
+ + + + + + 6. Session Management + + Track operations and review activity when needed. + + + +

+ Sway supports session management for tracking and coordinating + community operations across platforms. +

+
    +
  • Track active and completed sessions from the dashboard.
    • +
  • Monitor activity so staff can respond with context.
    • +
  • Review logs when investigating issues or handoffs.
    • +
  • + Coordinate session operations with the staff channels and roles + configured for your server. +
    • +
+ + + + + + 7. Dashboard Configuration + + Review the settings that control how Sway behaves. + + + +

+ Most setup work happens through the dashboard. Common configuration + areas include: +

+
    +
  • Verification channels
    • +
  • Log channels
    • +
  • Staff channels
    • +
  • Role mappings
    • +
  • Permission settings
    • +
  • Moderation settings
    • +
  • Session settings
    • +
  • Community requirements
    • +
+ + + + + + 8. Best Practices + + Keep the setup understandable for members and staff. + + + +
    +
  • Test changes before rollout.
    • +
  • Keep logs enabled.
    • +
  • Use clear verification instructions.
    • +
  • Avoid unnecessary administrator permissions.
    • +
  • Regularly review staff actions.
    • +
  • Keep role mappings organized.
    • +
  • Review flagged users before taking action.
    • +
+ + + + + + 9. Troubleshooting + + Common setup issues and first checks. + + + +
    +
  • + + Users cannot verify: + {" "} + Check that the verification channel is visible, the instructions + are current, and users are following the correct account linking + flow. +
    • +
  • + + Roles are not being assigned: + {" "} + Review role mappings, role hierarchy, and whether Sway has + permission to manage the target roles. +
    • +
  • + + Bot cannot send messages: + {" "} + Confirm channel permissions, server permissions, and any channel + overrides that may block Sway. +
    • +
  • + + Dashboard changes are not applying: + {" "} + Confirm the correct server is selected, save the configuration + again, and refresh the dashboard before testing. +
    • +
  • + + Server is missing from dashboard: + {" "} + Make sure you are signed in with the correct Discord account and + have Owner or Administrator permissions for that server. +
    • +
  • + + Permission errors: + {" "} + Review Sway's server role, Discord role hierarchy, channel + overrides, and the permissions configured in the dashboard. +
    • +
+ + + + + + 10. Support + + Where to go when the dashboard checks are not enough. + + + +

+ For help with setup, verification, permissions, dashboard behavior, + or account linking, contact Sway through the official{" "} + + Support + {" "} + community. +

+ + + + + + + + This documentation may be updated as Sway services evolve. Continued + use of Sway means you should follow the current documentation and + policies. + + + +
+ ); +}