Skip to content

Commit

Permalink
removed rmagine
Browse files Browse the repository at this point in the history
  • Loading branch information
amock committed Dec 6, 2024
1 parent a63351a commit 18b1504
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,21 @@ mkdocs build --strict
mkdocs serve --strict
```

## Deploy to uos.github.io/rmagine_docs
## Deploy to naturerobots.github.io/mesh_navigation_docs

Anything pushed to branch `deploy` will trigger a Github Action that builds the website and updates [uos.github.io/rmagine_docs](https://uos.github.io/rmagine_docs)
Anything pushed to branch `deploy` will trigger a Github Action that builds the website and updates [naturerobots.github.io/mesh_navigation_docs](https://naturerobots.github.io/mesh_navigation_docs)

## Contributions

You are welcome to contribute to the docs of [Rmagine](https://github.com/uos/rmagine)! Thorough and clear documentation is essential. You can help us by correcting mistakes, improving content, or adding examples that facilitate user navigation and usage of the project. Please submit any documentation-related issues here. If you're making fixes or adding examples, don’t hesitate to submit a pull request afterward!
You are welcome to contribute to the docs of [Mesh Navigation](https://github.com/naturerobots/mesh_navigation)! Thorough and clear documentation is essential. You can help us by correcting mistakes, improving content, or adding examples that facilitate user navigation and usage of the project. Please submit any documentation-related issues here. If you're making fixes or adding examples, don’t hesitate to submit a pull request afterward!

### PR workflow

How to contribute to this documentation via pull requests:

1. Fork this repository.
2. Make changes on your forked repository.
3. Check locally on your machine if mkdocs is able to compile your changes ([instructions](https://github.com/uos/rmagine_docs)).
3. Check locally on your machine if mkdocs is able to compile your changes ([instructions](https://github.com/uos/mesh_navigation_docs)).
3. Go to Github and click "Pull Request", select this repository's "main" branch as target.
4. If you added new content, please provide a brief explanation of why you believe it is beneficial for the documentation.
5. Send PR.

0 comments on commit 18b1504

Please sign in to comment.