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-23 03:59:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #52 from nahuhh/to_master

Browse source 
repo: change url to master
This commit is contained in:
nahuhh 2024-09-27 09:21:44 +00:00 committed by GitHub
commit 7ac6223b93
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 3 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -15,7 +15,7 @@ Monero Docs intends to be a Knowledge Base and User Guide for interacting with M
Contributions are both encouraged and greatly appreciated. Contributions are both encouraged and greatly appreciated.
To contribute content, fork this repo and make a pull request to the test branch including your changes. To contribute content, fork this repo and make a pull request to the **`master`** branch including your changes.
1. On GitHub, fork the [monero-docs](https://github.com/monero-project/moneo-docs) repo 1. On GitHub, fork the [monero-docs](https://github.com/monero-project/moneo-docs) repo
2. Clone your newly created repo. (Note: replace `your-username` with your GitHub username) 2. Clone your newly created repo. (Note: replace `your-username` with your GitHub username)
@ -34,7 +34,7 @@ cd monero-docs
git checkout -b foobar git checkout -b foobar
``` ```
4. After making modifications, commit and push your changes to your topic branch 4. After making modifications, commit and push your changes to your topic branch
5. Open a PR against the monero-docs `master` branch 5. Open a PR against the monero-docs **`master`** branch
# Run the documentation server locally # Run the documentation server locally
@ -45,7 +45,6 @@ Note: You may need to first install `python3-venv` or the equivalent for your di
1. Navigate to your `monero-docs` repo 1. Navigate to your `monero-docs` repo
2. Create the python virtual environment 2. Create the python virtual environment
```bash ```bash
mkdir .monero-docs-venv
python3 -m venv .monero-docs-venv python3 -m venv .monero-docs-venv
. .monero-docs-venv/bin/activate . .monero-docs-venv/bin/activate
``` ```

2
mkdocs.yml
View file

@ -152,7 +152,7 @@ extra:
repo_name: 'monero-project/monero-docs' repo_name: 'monero-project/monero-docs'
repo_url: 'https://github.com/monero-project/monero-docs' repo_url: 'https://github.com/monero-project/monero-docs'
# todo: change to master branch # todo: change to master branch
edit_uri: blob/test/docs/ edit_uri: blob/master/docs/
markdown_extensions: markdown_extensions:
# https://squidfunk.github.io/mkdocs-material/extensions/admonition/ # https://squidfunk.github.io/mkdocs-material/extensions/admonition/