From 4c4c9398390fa67f3f8fe8585157f610c5469ee9 Mon Sep 17 00:00:00 2001 From: taskylizard <75871323+taskylizard@users.noreply.github.com> Date: Mon, 22 Jul 2024 21:36:24 +0000 Subject: [PATCH] docs: update contribution guide --- CONTRIBUTING.md | 13 ++++++++----- README.md | 4 +++- docs/contribute.md | 1 + docs/index.md | 3 +++ 4 files changed, 15 insertions(+), 6 deletions(-) create mode 100644 docs/contribute.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 48dca90..f5d6640 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,10 +10,15 @@ You can contribute to the project in various ways: For site generation, we use [Vitepress](https://vitepress.dev), so you'll need a working Node.js environment installed. Refer to its documentation for making changes to Vitepress itself. +You can also make changes in your browser using: +[![Open in Codeflow](https://developer.stackblitz.com/img/open_in_codeflow.svg)](https://pr.new/privateersclub/wiki) + +Please look into [StackBlitz's browsers support](https://developer.stackblitz.com/platform/webcontainers/browser-support) for this, as notably Safari and Firefox can be less supported and unusable for this. + You will also need some hands-on experience with TypeScript if you're going to contribute to improving internals. -The root directory is `docs/`. +The root website directory is `docs/`. ## Content @@ -22,9 +27,7 @@ Markdown files. ## Translations -:::warning This is still a work in progress. ::: - -See and [our tracker](https://megathread.pages.dev/_translations). +See https://vitepress.dev/guide/i18n and [our tracker](https://megathread.pages.dev/_translations). There are two things to translate: content and strings used in Vitepress (sidebar, nav, etc.). @@ -32,7 +35,7 @@ Start by creating a folder in `docs/` and write your content in the exac Then, edit Vitepress strings. This may seem daunting, especially if you haven't used TypeScript or dealt with configurations like these before, but it shouldn't be overly difficult, and you don't -have to do it now. +have to do it too, I (tasky) can take care of it! Create your locale file in `docs/.vitepress/locales/.ts`, copying over the format from the root English file, and start editing. diff --git a/README.md b/README.md index c99c19b..82bc28a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # privateersclub/wiki Welcome to the most comprehensive game piracy wiki on the Internet. View it on -. +https://megathread.pages.dev. ## Contribute @@ -12,6 +12,8 @@ Here are a few ways you can get involved: - **Questions:** If you have questions or need assistance, join our [Discord](https://discord.gg/jz8dUnnD6Q) server. - **Suggestions:** Have ideas? We'd love to hear them! Join our server to share your suggestions. +- **Make Changes:** Have changes in mind? Send them, we would love to discuss! Read our [contribution guide](https://megathread.pages.dev/contribute) and open the entire website right in your browser: +[![Open in Codeflow](https://developer.stackblitz.com/img/open_in_codeflow.svg)](https://pr.new/privateersclub/wiki) ## Follow us diff --git a/docs/contribute.md b/docs/contribute.md new file mode 100644 index 0000000..81bd219 --- /dev/null +++ b/docs/contribute.md @@ -0,0 +1 @@ + diff --git a/docs/index.md b/docs/index.md index 518ccef..10a9959 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,8 +11,11 @@ hero: actions: - text: Get Started link: /glossary + - text: Contribute + link: /contribute - text: Translations link: /_translations + theme: alt features: - icon: ✏️