-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
190 additions
and
12 deletions.
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,195 @@ | ||
# Welcome to MkDocs | ||
# Edra, Equipe de Robótica Área da Universidade de Brasília Documentation | ||
|
||
For full documentation visit [mkdocs.org](https://www.mkdocs.org). | ||
## Table of Contents | ||
|
||
## Commands | ||
1. [Introduction](#introduction) | ||
2. [Team Overview](#team-overview) | ||
3. [Robots](#robots) | ||
4. [Projects](#projects) | ||
5. [Software](#software) | ||
6. [Hardware](#hardware) | ||
7. [Training and Workshops](#training-and-workshops) | ||
8. [Community Engagement](#community-engagement) | ||
9. [Contact Information](#contact-information) | ||
|
||
* `mkdocs new [dir-name]` - Create a new project. | ||
* `mkdocs serve` - Start the live-reloading docs server. | ||
* `mkdocs build` - Build the documentation site. | ||
* `mkdocs -h` - Print help message and exit. | ||
--- | ||
|
||
## Introduction | ||
|
||
Welcome to the official documentation of Edra, Equipe de Robótica Área da Universidade de Brasília. This documentation provides an overview of our team, projects, robots, and more. | ||
|
||
--- | ||
|
||
## Team Overview | ||
|
||
### Mission | ||
|
||
Our mission is to... | ||
|
||
### Vision | ||
|
||
Our vision is to... | ||
|
||
### Values | ||
|
||
- Innovation | ||
- Collaboration | ||
- Excellence | ||
|
||
--- | ||
|
||
## Robots | ||
|
||
### Robot A | ||
|
||
#### Overview | ||
|
||
Description of Robot A... | ||
|
||
#### Features | ||
|
||
- Feature 1 | ||
- Feature 2 | ||
- Feature 3 | ||
|
||
#### Documentation | ||
|
||
[Robot A User Manual](robotA_user_manual.md) | ||
|
||
### Robot B | ||
|
||
#### Overview | ||
|
||
Description of Robot B... | ||
|
||
#### Features | ||
|
||
- Feature 1 | ||
- Feature 2 | ||
- Feature 3 | ||
|
||
#### Documentation | ||
|
||
[Robot B User Manual](robotB_user_manual.md) | ||
|
||
--- | ||
|
||
## Projects | ||
|
||
### Project X | ||
|
||
#### Overview | ||
|
||
Description of Project X... | ||
|
||
#### Objectives | ||
|
||
- Objective 1 | ||
- Objective 2 | ||
|
||
#### Documentation | ||
|
||
[Project X Documentation](projectX_documentation.md) | ||
|
||
### Project Y | ||
|
||
#### Overview | ||
|
||
Description of Project Y... | ||
|
||
#### Objectives | ||
|
||
- Objective 1 | ||
- Objective 2 | ||
|
||
#### Documentation | ||
|
||
[Project Y Documentation](projectY_documentation.md) | ||
|
||
--- | ||
|
||
## Software | ||
|
||
### Software A | ||
|
||
#### Overview | ||
|
||
Description of Software A... | ||
|
||
#### Installation Guide | ||
|
||
[Software A Installation Guide](softwareA_installation_guide.md) | ||
|
||
### Software B | ||
|
||
#### Overview | ||
|
||
Description of Software B... | ||
|
||
#### Installation Guide | ||
|
||
[Software B Installation Guide](softwareB_installation_guide.md) | ||
|
||
--- | ||
|
||
## Hardware | ||
|
||
### Hardware A | ||
|
||
#### Overview | ||
|
||
Description of Hardware A... | ||
|
||
#### Specifications | ||
|
||
- Specification 1 | ||
- Specification 2 | ||
|
||
### Hardware B | ||
|
||
#### Overview | ||
|
||
Description of Hardware B... | ||
|
||
#### Specifications | ||
|
||
- Specification 1 | ||
- Specification 2 | ||
|
||
--- | ||
|
||
## Training and Workshops | ||
|
||
### Training Programs | ||
|
||
- Training Program 1 | ||
- Training Program 2 | ||
|
||
### Workshops | ||
|
||
- Workshop 1 | ||
- Workshop 2 | ||
|
||
--- | ||
|
||
## Community Engagement | ||
|
||
### Outreach Programs | ||
|
||
- Outreach Program 1 | ||
- Outreach Program 2 | ||
|
||
### Events | ||
|
||
- Event 1 | ||
- Event 2 | ||
|
||
--- | ||
|
||
## Contact Information | ||
|
||
- Email: [email protected] | ||
- Phone: +55 XX XXXX-XXXX | ||
- Address: Universidade de Brasília, Campus Darcy Ribeiro, Asa Norte, Brasília - DF, Brazil | ||
|
||
## Project layout | ||
|
||
mkdocs.yml # The configuration file. | ||
docs/ | ||
index.md # The documentation homepage. | ||
... # Other markdown pages, images and other files. |