Skip to content
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

Do better organization by using subfolders #21

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
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
6 changes: 3 additions & 3 deletions src/components/MobileNavbar.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export default function MobileNavbar() {
return {
navbarItem: i,
parentEntry: posts.find(
(p) => p.params.slug === i.title.toLowerCase()
(p) => p.params.slug === i.slug
)!,
};
})
Expand Down Expand Up @@ -61,7 +61,7 @@ export default function MobileNavbar() {
key={post.params.slug}
href={[
"/docs",
c.toLowerCase(),
// c.toLowerCase(),
post.params.slug,
].join("/")}
>
Expand All @@ -77,7 +77,7 @@ export default function MobileNavbar() {
<a
href={[
"/docs",
parentEntry.params.slug,
// parentEntry.params.slug,
post.params.slug,
].join("/")}
key={post.params.slug}
Expand Down
23 changes: 15 additions & 8 deletions src/components/Navbar.astro
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,24 @@ import { ScrollArea } from "./ui/scroll-area";
return {
navbarItem: i,
parentEntry: posts.find(
(p) => p.params.slug === i.title.toLowerCase()
(p) => p.props.entry.slug === i.slug
)!,
};
})
.map(({ navbarItem, parentEntry }) => (
.map(({ navbarItem, parentEntry }) => {
// if (parentEntry === undefined) return
return (
<div class="pb-4">
<a
{ parentEntry ? <a
href={["/docs", parentEntry.params.slug].join("/")}
class="text-sm font-semibold hover:underline"
>
{parentEntry.props.entry.data.title}
</a>
</a> : <span
class="text-sm font-semibold"
>
{navbarItem.title}
</span> }
<div class="grid grid-flow-row auto-rows-max text-sm mt-1 w-5/6">
{navbarItem.subcategories !== undefined &&
navbarItem.subcategories.length > 0 && (
Expand All @@ -48,7 +54,7 @@ import { ScrollArea } from "./ui/scroll-area";
class="hover:underline py-1"
href={[
"/docs",
c.toLowerCase(),
// c.toLowerCase(),
post.params.slug,
].join("/")}
>
Expand All @@ -60,13 +66,13 @@ import { ScrollArea } from "./ui/scroll-area";
))}
</>
)}
{groupedNavbarParents[parentEntry.props.entry.data.title]?.map(
{groupedNavbarParents[navbarItem.title]?.map(
(post) => (
<a
class="text-muted-foreground hover:underline py-1"
href={[
"/docs",
getParent(post)!.toLowerCase(),
// getParent(post)!.toLowerCase(),
post.params.slug,
].join("/")}
>
Expand All @@ -76,7 +82,8 @@ import { ScrollArea } from "./ui/scroll-area";
)}
</div>
</div>
))
)
})
}
</ScrollArea>

Expand Down
40 changes: 31 additions & 9 deletions src/components/navigationConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,44 @@ import { getDocPaths } from "@/utils/get_paths";
export const navbarParents = [
{
title: "Guidelines",
slug: "guidelines",
subcategories: [
"Pinned",
"Songs",
"Albums",
"Artists",
"Secondary-entry-types",
"Other-guidelines",
"Secondary entry types",
"Other guidelines",
],
},
{ title: "Documentation" },
{ title: "Development" },
{ title: "Other" },
{ title: "UtaiteDB" },
{ title: "TouhouDB" },
{ title: "Japanese" },
{ title: "Chinese" },
{
title: "Documentation",
slug: "documentation",
},
{
title: "Development",
slug: "development",
},
{
title: "Other",
slug: "other",
},
{
title: "UtaiteDB",
slug: "utaitedb",
},
{
title: "TouhouDB",
slug: "touhoudb",
},
{
title: "Japanese",
slug: "japanese",
},
{
title: "Chinese",
slug: "chinese",
},
];

export const headerNavItems = [
Expand Down
1 change: 1 addition & 0 deletions src/content/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ const docsCollection = defineCollection({
description: z.string(),
parent: z.string().optional(),
tags: z.array(z.string()).default([]),
redirectFrom: z.array(z.string()).default([])
}),
});

Expand Down
2 changes: 2 additions & 0 deletions src/content/docs/Discussion rules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Discussion rules
description: Discussion rules
parent: Pinned
redirectFrom:
- pinned/discussion-rules
tags: ["documentation", "vocadb"]
---

Expand Down
2 changes: 2 additions & 0 deletions src/content/docs/Entry reports.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Entry reports
description: Entry reports
parent: Pinned
redirectFrom:
- pinned/entry-reports
tags: ["draft", "editing", "guidelines", "moderation", "report", "user", "documentation", "vocadb"]
---

Expand Down
2 changes: 2 additions & 0 deletions src/content/docs/Quick guide for new editors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Quick guide for new editors
description: Quick guide for new editors
parent: Pinned
redirectFrom:
- pinned/quick-guide-for-new-editors
tags: ["draft", "editing", "guidelines", "user", "documentation", "vocadb"]
---

Expand Down
2 changes: 2 additions & 0 deletions src/content/docs/Rule Changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Rule Changelog
description: Rule Changelog
parent: Pinned
redirectFrom:
- pinned/rule-changelog
tags: ["guidelines", "moderation", "documentation", "vocadb"]
---

Expand Down
2 changes: 2 additions & 0 deletions src/content/docs/VocaDB editing FAQ.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: VocaDB editing FAQ
description: VocaDB editing FAQ
parent: Pinned
redirectFrom:
- pinned/vocadb-editing-faq
tags: ["editing", "guidelines", "documentation", "vocadb"]
---

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,82 +1,85 @@
---
title: VocaDB - How to help
description: VocaDB - How to help
parent: Pinned
tags: ["development", "documentation", "feature requests", "github", "translation", "vocadb"]
---

VocaDB is fully a volunteer-based organization. If you're interested in contributing in various ways, please read ahead.

## General ways to help

### Editing entries

VocaDB aims to be the most accurate and complete source of voice synth content (albums, artists, songs, etc.). You can help with this by adding new and/or improving the existing entries.

It's helpful to also send [entry reports](/docs/pinned/entry-reports) when noticing errors. Anyone can remind and educate other editors about the guidelines, as long as the tone of the message or the comment is diplomatic and appropriate.

Some shared *entry lists* have also been made that focus on certain tasks: -upcoming-

### Improving rules and guidelines

Our guidelines and rules sharpen and evolve as edge cases emerge and new trends appear.

Guideline discussion and debate is currently mostly limited to a non-public [discord](https://discord.com/invite/3bwXQNXKCz) channel (#mods-and-trusted), but thoughtful guideline suggestions and clarification requests are always welcome.

The wiki content (including this text) is hosted on [Github](https://github.com/VocaDB/Wiki), which accepts change proposals through [pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). Rule and guideline changes should always be discussed first, but PRs that fix typos or clarify sentences for example are always accepted and quickly merged.

### Promoting the website

As a collaborative project, we benefit from having a large and diverse userbase.

VocaDB api enables the development of [external services](/docs/documentation/services-that-make-use-of-vocadb-apis).

## If you're a programmer (C#, ASP.NET Core, TypeScript, React)

See the instructions in [the README](https://github.com/VocaDB/vocadb#readme).

For fixing bugs and implementing feature requests, fork and create a pull request to the main repository. Participating in a non-public [discord](https://discord.com/invite/3bwXQNXKCz) channel (#dev-talk) is recommended.

## If you're a programmer (Mobile, Dart)

VocaDB also exists as a native Android + Apple mobile app, created by [up2code](https://vocadb.net/Profile/up2up). The app code repository can be found on [GitHub/VocaDB/VocaDB-App](https://github.com/VocaDB/VocaDB-App).

## If you're a programmer (any language)

GitHub issues labeled with [external solution possible](https://github.com/VocaDB/vocadb/issues?q=is%3Aissue+is%3Aopen+label%3A%22external+solution+possible%22) can be implemented or workaround-ed in some form with any language.

If you manage to create/find a working solution or workaround for these issues, please mention it on the relevant github issue.

The public [#api-projects](https://discord.com/channels/309072240639737866/1039922389301072014) -channel can be used as a relevant discussion area.

## If you know non-English languages

We need people who know specific languages, especially Japanese and Chinese.

Please update your "known languages" in your [profile settings](https://vocadb.net/User/MySettings) and let us know if we can contact you if/when help is needed.

The relevant discussion area for translation-related topics is [#translate -channel](https://discord.com/channels/309072240639737866/808128811056889886) on Discord.

Website translations are managed through [Crowdin](https://crowdin.com/project/vocadb), a localization management platform.

-> [Project invite link](https://crowdin.com/project/vocadb/invite?h=8d85a8e422a7f8a6ea089630935c7fd61702299)

-> [Guide: Translating VocaDB](/docs/documentation/translating-vocadb/translating-vocadb)

Translations for the VocaDB wiki pages are also welcome. These are currently implemented as separate wiki pages.

## Donations

VocaDB is free to use for everyone and does not display any sort of ads. However, running a website is not free. VocaDB, UtaiteDB and TouhouDB are running on servers that need to be paid monthly.

[Patreon](https://www.patreon.com/vocadb) is our main source of funding.

Additionally, if you want to donate to the [VocaDB-App](https://github.com/VocaDB/VocaDB-App) hosted by [up2code](https://vocadb.net/Profile/up2up), please visit the dedicated [Ko-fi page](https://ko-fi.com/up2up039).

## Other

For any improvement ideas or feature requests for the website, please first search through [the issue tracker](https://github.com/VocaDB/vocadb/issues) before creating a new issue (="ticket"). High-quality proposals are especially appreciated. Voting and commenting on the existing proposals can be helpful as well.

Our community is mostly gathered up in our [discord server](https://discord.com/invite/3bwXQNXKCz). We try to maintain a mature and friendly atmosphere.

---
title: VocaDB - How to help
description: VocaDB - How to help
parent: Pinned
tags: ["development", "documentation", "feature requests", "github", "translation", "vocadb"]
redirectFrom:
- pinned/vocadb-how-to-help
- pinned/vocadb-help-wanted
---

VocaDB is fully a volunteer-based organization. If you're interested in contributing in various ways, please read ahead.

## General ways to help

### Editing entries

VocaDB aims to be the most accurate and complete source of voice synth content (albums, artists, songs, etc.). You can help with this by adding new and/or improving the existing entries.

It's helpful to also send [entry reports](/docs/pinned/entry-reports) when noticing errors. Anyone can remind and educate other editors about the guidelines, as long as the tone of the message or the comment is diplomatic and appropriate.

Some shared *entry lists* have also been made that focus on certain tasks: -upcoming-

### Improving rules and guidelines

Our guidelines and rules sharpen and evolve as edge cases emerge and new trends appear.

Guideline discussion and debate is currently mostly limited to a non-public [discord](https://discord.com/invite/3bwXQNXKCz) channel (#mods-and-trusted), but thoughtful guideline suggestions and clarification requests are always welcome.

The wiki content (including this text) is hosted on [Github](https://github.com/VocaDB/Wiki), which accepts change proposals through [pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). Rule and guideline changes should always be discussed first, but PRs that fix typos or clarify sentences for example are always accepted and quickly merged.

### Promoting the website

As a collaborative project, we benefit from having a large and diverse userbase.

VocaDB api enables the development of [external services](/docs/documentation/services-that-make-use-of-vocadb-apis).

## If you're a programmer (C#, ASP.NET Core, TypeScript, React)

See the instructions in [the README](https://github.com/VocaDB/vocadb#readme).

For fixing bugs and implementing feature requests, fork and create a pull request to the main repository. Participating in a non-public [discord](https://discord.com/invite/3bwXQNXKCz) channel (#dev-talk) is recommended.

## If you're a programmer (Mobile, Dart)

VocaDB also exists as a native Android + Apple mobile app, created by [up2code](https://vocadb.net/Profile/up2up). The app code repository can be found on [GitHub/VocaDB/VocaDB-App](https://github.com/VocaDB/VocaDB-App).

## If you're a programmer (any language)

GitHub issues labeled with [external solution possible](https://github.com/VocaDB/vocadb/issues?q=is%3Aissue+is%3Aopen+label%3A%22external+solution+possible%22) can be implemented or workaround-ed in some form with any language.

If you manage to create/find a working solution or workaround for these issues, please mention it on the relevant github issue.

The public [#api-projects](https://discord.com/channels/309072240639737866/1039922389301072014) -channel can be used as a relevant discussion area.

## If you know non-English languages

We need people who know specific languages, especially Japanese and Chinese.

Please update your "known languages" in your [profile settings](https://vocadb.net/User/MySettings) and let us know if we can contact you if/when help is needed.

The relevant discussion area for translation-related topics is [#translate -channel](https://discord.com/channels/309072240639737866/808128811056889886) on Discord.

Website translations are managed through [Crowdin](https://crowdin.com/project/vocadb), a localization management platform.

-> [Project invite link](https://crowdin.com/project/vocadb/invite?h=8d85a8e422a7f8a6ea089630935c7fd61702299)

-> [Guide: Translating VocaDB](/docs/documentation/translating-vocadb/translating-vocadb)

Translations for the VocaDB wiki pages are also welcome. These are currently implemented as separate wiki pages.

## Donations

VocaDB is free to use for everyone and does not display any sort of ads. However, running a website is not free. VocaDB, UtaiteDB and TouhouDB are running on servers that need to be paid monthly.

[Patreon](https://www.patreon.com/vocadb) is our main source of funding.

Additionally, if you want to donate to the [VocaDB-App](https://github.com/VocaDB/VocaDB-App) hosted by [up2code](https://vocadb.net/Profile/up2up), please visit the dedicated [Ko-fi page](https://ko-fi.com/up2up039).

## Other

For any improvement ideas or feature requests for the website, please first search through [the issue tracker](https://github.com/VocaDB/vocadb/issues) before creating a new issue (="ticket"). High-quality proposals are especially appreciated. Voting and commenting on the existing proposals can be helpful as well.

Our community is mostly gathered up in our [discord server](https://discord.com/invite/3bwXQNXKCz). We try to maintain a mature and friendly atmosphere.

If you think you could be of help in any other way that wasn't mentioned in this page, please join the discord server or [contact us](/docs/footer/contact) in some other way.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Choosing the correct voicebank credit
description: Choosing the correct voicebank credit
parent: Other-guidelines
parent: Other guidelines
tags: ["documentation", "vocadb"]
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Content policy
description: Content policy
parent: Other-guidelines
parent: Other guidelines
tags: ["artists", "draft", "editing", "guidelines", "moderation", "tos", "documentation", "vocadb"]
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Content removal guidelines
description: Content removal guidelines
parent: Other-guidelines
parent: Other guidelines
tags: ["artists", "editing", "external links", "guidelines", "moderation", "songs", "tos", "user", "documentation", "vocadb"]
---

Expand Down
Loading