monero-project/monero-docs
monero-project/monero-docs
2
1
Fork 0
mirror of https://github.com/monero-project/monero-docs.git synced 2024-12-22 19:49:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #14 from nahuhh/README

Browse source 
readme: modify / update
This commit is contained in:
nahuhh 2024-08-18 22:41:44 +00:00 committed by GitHub
commit 17be5f09b6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 50 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

68
README.md
View file

@ -1,32 +1,64 @@
# MoneroDocs # Monero Docs
- [MoneroDocs](#monerodocs) This repository contains the source files to Monero Community documentation hosted at [docs.getmonero.org](https://docs.getmonero.org)
- [About](#about)
- [Contributing](#contributing) - [About](#about)
- [Contributing](#contributing)
- [Build](#build)
- [License](#license)
## About ## About
Monerodocs attempts to organize basic technical knowledge on Monero in one place. Monero Docs intends to be a Knowledge Base and User Guide for interacting with Monero.
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 ## Contributing
To contribute to MoneroDocs, you'll need to setup your local [Mkdocs-Material](https://squidfunk.github.io/mkdocs-material/) environment: Contributions are both encouraged and greatly appreciated.
```sh To contribute content, fork this repo and make a pull request to the test branch including your changes.
# Fork the monerodocs/md Github repo
# Clone your newly created repo- be sure to include the submodule flag 1. On GitHub, fork the [monero-docs](https://github.com/monero-project/moneo-docs) repo
git clone --recurse-submodules git@github.com:your-user-name/md.git 2. Clone your newly created repo. (Note: replace `your-username` with your GitHub username)
cd md via ssh:
```bash
# Install mkdocs dependencies git clone git@github.com:your-username/monero-docs
pip install mkdocs-material mkdocs-minify-plugin ```
via https:
```bash
git clone https://github.com/your-username/monero-docs
```
3. Navigate to the repo and create a new topic branch
```bash
cd monero-docs
git checkout -b foobar
```
4. After making modifications, commit and push your changes to your topic branch
5. Open a PR against the monero-docs `master` branch
# Run the documentation server locally # Run the documentation server locally
- The build process for mkdocs utilizes Python
- It is recommended to install python pip dependencies inside of a Virtual Environment [(venv)](https://squidfunk.github.io/mkdocs-material/guides/creating-a-reproduction/#environment)
Note: You may need to first install `python3-venv` or the equivalent for your distribution
1. Navigate to your `monero-docs` repo
2. Create the python virtual environment
```bash
mkdir .monero-docs-venv
python3 -m venv .monero-docs-venv
. .monero-docs-venv/bin/activate
```
3. Install mkdocs dependencies to the venv
```bash
pip install -r requirements.txt
```
4. Run the documentation server locally
```bash
python3 -m mkdocs serve python3 -m mkdocs serve
``` ```
5. View your changes at [http://localhost:8000](http://localhost:8000)
## License
The documentation is provided under the [MIT License](LICENSE).