Português · English
Thank you for your interest in contributing to Waypedia! To ensure consistency across all articles, please follow these guidelines.
Articles should be .mdx files and must be placed in the src folder. The file name must follow these rules:
- Use only lowercase letters
- Do not use accents, diacritics or special characters
- Replace any spaces with
_ - No spaces at the beginning or end of the name
Place the article in the appropriate subfolder inside src:
- For articles in Portuguese:
src/pt/ - For articles in English:
src/en/
Each article must start with a frontmatter formatted as follows:
---
id: "Unique article identifier (must be the same across translations)" # REQUIRED
title: "Article title" # REQUIRED
banner: "URL for a banner image" # optional
embed_image: "URL for the image that will show up in embed" # optional, if not specified, the banner will be used as embed image
short_description: "extremely short (something like 5 words long) description for the article" # optional
stub: false # optional, set to true if the article is too short due to lack of information
---optional means you don't necessarily need to include it in the frontmatter.
⚠ The id field must be identical for all translated versions of the articles.
After creating the article or adding a translation to it, add the following entry to mappings.json:
"article-id": {
"en": "english-article-file-name",
"pt": "portuguese-article-file-name"
}⚠ Do not include .mdx at the end of the article name in this definition. If your article doesn't have a certain translation yet, you may remove the line where the path to the specific translation would be specified.
Caution
Before submitting your contribution, make sure all the rules have been followed. Otherwise, your pull request may be rejected.
Pull Requests shall be initially made to the staging branch.
If you have any questions, feel free to ask. Thank you for contributing to Waypedia!