mirror of
https://github.com/privateersclub/wiki.git
synced 2024-11-22 21:29:52 +00:00
docs: update contribution guide
This commit is contained in:
parent
c5a660e3ab
commit
4c4c939839
@ -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 <https://vitepress.dev/guide/i18n> 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/<locale>` 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/<locale>.ts`, copying over the format from the
|
||||
root English file, and start editing.
|
||||
|
@ -1,7 +1,7 @@
|
||||
# privateersclub/wiki
|
||||
|
||||
Welcome to the most comprehensive game piracy wiki on the Internet. View it on
|
||||
<https://megathread.pages.dev>.
|
||||
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
|
||||
|
||||
|
1
docs/contribute.md
Normal file
1
docs/contribute.md
Normal file
@ -0,0 +1 @@
|
||||
<!--@include: ./../CONTRIBUTING.md -->
|
@ -11,8 +11,11 @@ hero:
|
||||
actions:
|
||||
- text: Get Started
|
||||
link: /glossary
|
||||
- text: Contribute
|
||||
link: /contribute
|
||||
- text: Translations
|
||||
link: /_translations
|
||||
theme: alt
|
||||
|
||||
features:
|
||||
- icon: ✏️
|
||||
|
Loading…
Reference in New Issue
Block a user