GetMonero.dev attempts to organize basic technical knowledge on Monero in one place. It is a continuation of the MoneroDocs repo.
While technical explanations are out there, knowledge is scattered through reddit posts, git comments, stack exchange answers, chat logs and the source code. This makes it hard to find complete and up-to-date explanations on advanced topics.
The goal is to educate and onboard power users faster.
Contributing is easy and much appreciated! You can contribute in the markdown format by opening a pull request.
The documentation is organized into various folders (skip over the ones that start with an underscore _). Each of these folders contain markdown files.
Each folder needs a markdown file in it with the same name, acting as the parent. Children markdown files can be added to the folder. Please follow another example folder for the correct header content or follow the Just the Docs documentation.
You will need to make a new branch to propose changes with a pull request.
If you do not know how to make a pull request, please create a GitHub issue with the page content you would like to add or modify, and someone will help you out with the changes.
Images should be placed under a folder in /images using the same folder name for the relevant markdown file.
When linking images, follow a format like this:
[{:width="32%"}](/images/image.jpg)
This will format the image to 1/3 of the width of the screen, and it will allow a user to click on the image to get a full-screen view. This makes sense for some vertical images.
In select circumstances (such as short, wide images), it's better to make the image full-width. To do this, delete {:width="32%"} from the formatting above.
Please use avif, webp, or svg images instead of jpg or png images. webp and avif are supported by all modern browsers.
Videos should have an accompanying image, and the link should go to the external video. For example:
[{:width="100%"}](https://youtube.com/watch?v=<insert-youtube-video-id-here>)
At the time of writing, maxresdefault.jpg returns a 1280x720 image.
It can be helpful to inspect your local changes to the documentation before contributing back to the original repository, or if you wish to view the documentation offline.
You need to install following packages:
sudo apt install ruby-full bundlerFirst, using GitHub's web user interface, fork the original repository to your own GitHub account. Then, clone your repository to your local computer, make sure to change ${YOUR-USERNAME} with your GitHub account name:
git clone https://github.com/${YOUR-USERNAME}/getmonero.dev.git
cd getmonero.devNow set your git config for your local repo:
git config user.name '${YOUR-USERNAME}'
git config user.email '${YOUR-EMAIL}'If you don't want to specify your email address, simply enter a dummy one, like [email protected]. Note: in order to further protect your email privacy while using GitHub, review your GitHub account settings.
Create a new branch and checkout to that branch. Make sure the <branch-name> reflects your local changes to the documentation:
git checkout -b <branch-name>Now compile the documentation. Create a local directory for storing the compilation dependencies:
mkdir -p vendor/bundle
bundle config set path vendor/bundleNow install the dependencies:
bundle installOnce the installation is complete, you can run your Jekyll project using:
bundle exec jekyll serveYou can visit http://127.0.0.1:4000 on your web browser and browse the getmonero.dev documentation. The changes to your local branch will appear in real time as you are doing the edits.
Once you are done with your changes to your local copy of the documentation, you should push your changes to your GitHub repository. Then, using GitHub's web user interface, you should create a pull request from your branch to the getmonero.dev main branch.