-
Notifications
You must be signed in to change notification settings - Fork 0
Migrate docs to VitePress and restructure #5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Bocon778
wants to merge
10
commits into
main
Choose a base branch
from
dev
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
4896229
Migrate docs to VitePress and restructure
Bocon778 62538e7
Update config.mts
Bocon778 43e434a
Edit Links
Bocon778 24e39cc
Update config.mts
Bocon778 0c8a9a8
Update config.mts
Bocon778 7b4b59b
Update index.md
Bocon778 0e96c7d
Create index.md
Bocon778 6152281
Update config.mts
Bocon778 3a9cf96
Add settings
Bocon778 2bc02bf
Linting Cleanup
Bocon778 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| node_modules | ||
| cache | ||
| dist |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| import { defineConfig } from "vitepress"; | ||
|
|
||
| export default defineConfig({ | ||
| title: "Bloxbind Documentation", | ||
| description: | ||
| "Welcome to the Bloxbind documentation where we will go over how to setup and configure Bloxbind for your community.", | ||
| sitemap: { | ||
| hostname: 'https://docs.bloxbind.com', | ||
| lastmodDateOnly: false | ||
| }, | ||
| themeConfig: { | ||
| siteTitle: "Bloxbind Documentation", | ||
| editLink: { | ||
| pattern: "https://github.com/bloxbind/docs/edit/main/:path", | ||
| text: "Edit this page on GitHub", | ||
| }, | ||
| lastUpdated: { | ||
| text: "Last Updated", | ||
| formatOptions: { | ||
| dateStyle: "full", | ||
| timeStyle: "medium", | ||
| }, | ||
| }, | ||
| sidebar: [ | ||
| { | ||
| text: "Introduction", | ||
| collapsed: false, | ||
| items: [ | ||
| { text: "Getting Started", link: "/" }, | ||
| { text: "FAQ", link: "/faq/" }, | ||
| { text: "Team", link: "/team/" }, | ||
| { text: "Changelog", link: "/changelog/" }, | ||
| ], | ||
| }, | ||
| { | ||
| text: "Settings", | ||
| collapsed: false, | ||
| items: [ | ||
| { text: "Auto Verification", link: "/autoverif/" }, | ||
| { text: "Naming Scheme", link: "/naming/" }, | ||
| { text: "Role Links", link: "/rolelinks/" }, | ||
| { text: "Remove Roles", link: "/removeroles/" }, | ||
| { text: "Minimum Account Age", link: "/minaccountage/" }, | ||
| ], | ||
| }, | ||
| ], | ||
|
|
||
| socialLinks: [{ icon: "github", link: "https://github.com/bloxbind/docs" }], | ||
| }, | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # Auto Verification | ||
|
|
||
| When enabled, automatic verification will verify users as soon as they join the server. | ||
|
|
||
| You can find this setting in the General tab under Server Settings on the web dashboard. | ||
|
|
||
| ## Example | ||
|
|
||
|  |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| # FAQ | ||
|
|
||
| ## Missing Permissions | ||
| ## Missing Permissions | ||
|
|
||
| Q: Why can't the bot assign a role? | ||
| A: The bot's highest role must be higher than the role it tries to assign. Check Server Settings → Roles. | ||
| A: The bot's highest role must be higher than the role it tries to assign. Check Server Settings → Roles. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # Naming Scheme | ||
|
|
||
| The naming scheme lets the bot automatically update a user's Discord nickname based on selected criteria. | ||
|
|
||
| You can find this setting in the Automation tab under Server Settings on the web dashboard. | ||
|
|
||
| ## Supported Options | ||
|
|
||
| - The naming scheme currently supports a fixed set of options. | ||
| - Variables: | ||
| - \{RobloxUsername} | ||
| - \{RobloxDisplay} | ||
| - \{DiscordUsername} | ||
| - Symbols: | ||
| - @ | ||
| - \# | ||
| - | | ||
| - ( ) | ||
| - " " | ||
| - ' ' | ||
| - < > | ||
|
|
||
| ## Example | ||
|
|
||
|  | ||
|
|
||
| ## Notes & Limits | ||
|
|
||
| - Discord nicknames have a 32-character limit, so longer generated names may be truncated or rejected. | ||
| - You can view or change these settings in the dashboard on our website. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: Sidebar links for "Remove Roles" and "Minimum Account Age" point to empty markdown files, which will render as blank pages in the documentation.
Severity: MEDIUM
Suggested Fix
Populate the
removeroles/index.mdandminaccountage/index.mdfiles with the correct documentation for their respective features. If the documentation is not yet ready, remove the links from the sidebar configuration in.vitepress/config.mtsto prevent users from navigating to empty pages.Prompt for AI Agent