https://github.com/roboticslab-uc3m/developer-manual
Developer Manual @ roboticslab-uc3m
https://github.com/roboticslab-uc3m/developer-manual
best-practices documentation gitbook manual
Last synced: 5 months ago
JSON representation
Developer Manual @ roboticslab-uc3m
- Host: GitHub
- URL: https://github.com/roboticslab-uc3m/developer-manual
- Owner: roboticslab-uc3m
- Created: 2016-11-26T13:03:41.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-05-22T13:53:11.000Z (about 1 year ago)
- Last Synced: 2025-05-22T15:07:54.881Z (about 1 year ago)
- Topics: best-practices, documentation, gitbook, manual
- Language: Python
- Homepage: https://robots.uc3m.es/developer-manual/
- Size: 1.88 MB
- Stars: 1
- Watchers: 19
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
[](https://github.com/roboticslab-uc3m)
# Developer Manual
Developer Manual @ [roboticslab-uc3m](https://github.com/roboticslab-uc3m)
Currently hosted at https://robots.uc3m.es/developer-manual/
## If you have any doubts or comments
Please read the [Asking Questions](asking-questions.md) section, and once you've succeded with its [self-evaluation](asking-questions.md#self-evaluation-time) follow the recommendations by commenting publicly [HERE](https://github.com/roboticslab-uc3m/developer-manual/issues/new) if required
## How-To's
* [How to serve on localhost](#how-to-serve-on-localhost)
* [How to upload changes to GitHub](#how-to-upload-changes-to-github)
### How to serve on localhost
It is useful to serve on `localhost` to modify the website and see changes locally.
1. From the root of the project, run the following command:
```bash
pip install -r requirements.txt
mkdocs serve
```
1. You can now browse the site at the default location:
### How to upload changes to GitHub
This project is managed as any project on [GitHub](https://www.github.com). You may use [Git](https://git-scm.com) or even the GitHub web interface, both on which you can find many tutorials online. The following points are specific to the MkDocs mechanism used:
1. Please **do not upload** the `site/` folder. It is auto-generated locally, and the same should happen on the MkDocs servers.
1. It is safe to `git push` to any upstream branch, just remember that what is on `master` is what will be actually rendered as the website.