Skip to content

Commit bed6605

Browse files
committed
added new strucuture
1 parent 1c6df8a commit bed6605

8 files changed

+183
-1
lines changed

docs/contributing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ Please use the [New Page Template](#new-page-template)
9191
Please copy this code as a template to create your new page
9292

9393
```markdown
94-
<!-- This page was contributed by: -->
9594
# Page title
95+
<!-- This page was contributed by: -->
9696

9797
Subtitle
9898

docs/examples/basic_elevator.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# **WIP** Basic Elevator Subsystem
2+
<!-- This page was contributed by: -->
3+
4+
Subtitle
5+
6+
<!-- Add a page image to make it pretty! -->
7+
![Image Title](imageURL)
8+
9+
## Overview
10+
11+
This section will help you learn to create a basic elevator or lift subsystem.
12+
13+
This subsystem will contain:
14+
15+
- Two motors in a single gear box
16+
- Use single encoder to lift to specific distances
17+
- 3 distances 2, 5, 10 inches
18+
- 3 buttons to get to those distances
19+
- Hard stop safeties using limit switches
20+
- Top and bottom
21+
- Run motors at 25% speed so we can watch easier
22+
23+
**See table of contents for a breakdown of this section.**
24+
25+
***
26+
27+
## Section One
28+
29+
- Some info
30+
- Some other into
31+
- Some sub info
32+
33+
### Section One Subsection
34+
35+
***
36+
37+
## Section Two
38+
39+
- Info
40+
- Info 2
41+
42+
!!! Tip
43+
This is a tip.

docs/examples/basic_shooter.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# **WIP** Basic Shooting Subsystem
2+
<!-- This page was contributed by: -->
3+
4+
Subtitle
5+
6+
<!-- Add a page image to make it pretty! -->
7+
![Image Title](imageURL)
8+
9+
## Overview
10+
11+
This section will help you learn to BLANK.
12+
13+
**See table of contents for a breakdown of this section.**
14+
15+
***
16+
17+
## Section One
18+
19+
- Some info
20+
- Some other into
21+
- Some sub info
22+
23+
### Section One Subsection
24+
25+
***
26+
27+
## Section Two
28+
29+
- Info
30+
- Info 2
31+
32+
!!! Tip
33+
This is a tip.

docs/examples/pid_elevator.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# **WIP** PID Driven Elevator
2+
<!-- This page was contributed by: -->
3+
4+
Subtitle
5+
6+
<!-- Add a page image to make it pretty! -->
7+
![Image Title](imageURL)
8+
9+
## Overview
10+
11+
This section will help you learn to BLANK.
12+
13+
**See table of contents for a breakdown of this section.**
14+
15+
***
16+
17+
## Section One
18+
19+
- Some info
20+
- Some other into
21+
- Some sub info
22+
23+
### Section One Subsection
24+
25+
***
26+
27+
## Section Two
28+
29+
- Info
30+
- Info 2
31+
32+
!!! Tip
33+
This is a tip.

docs/examples/pid_shooter.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# **WIP** PID Driven Shooter
2+
<!-- This page was contributed by: -->
3+
4+
Subtitle
5+
6+
<!-- Add a page image to make it pretty! -->
7+
![Image Title](imageURL)
8+
9+
## Overview
10+
11+
This section will help you learn to BLANK.
12+
13+
**See table of contents for a breakdown of this section.**
14+
15+
***
16+
17+
## Section One
18+
19+
- Some info
20+
- Some other into
21+
- Some sub info
22+
23+
### Section One Subsection
24+
25+
***
26+
27+
## Section Two
28+
29+
- Info
30+
- Info 2
31+
32+
!!! Tip
33+
This is a tip.

docs/programming/deploying.md

+2
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,5 @@ To deploy code, first make sure your computer is connected to the robot in **ON
5252
2. Enable the robot
5353
3. Try moving the joysticks on your controller when enabled.
5454
1. If it doesn’t, check your port numbers for your controller, axes, and motor controllers
55+
56+
<!-- TODO: make note about reading error log. resource allocation and robots don't quit -->

mkdocs.yml

+5
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ nav:
2626
- 'programming/autonomous.md'
2727
- 'programming/pid.md'
2828
# - 'programming/super_core.md'
29+
- Example Subsystems:
30+
- 'examples/basic_elevator.md'
31+
- 'examples/basic_shooter.md'
32+
- 'examples/pid_elevator.md'
33+
- 'examples/pid_shooter.md'
2934
- Version Control:
3035
- 'version_control/github.md'
3136

page_template.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Page title
2+
<!-- This page was contributed by: -->
3+
4+
Subtitle
5+
6+
<!-- Add a page image to make it pretty! -->
7+
![Image Title](imageURL)
8+
9+
## Overview
10+
11+
This section will help you learn to BLANK.
12+
13+
**See table of contents for a breakdown of this section.**
14+
15+
***
16+
17+
## Section One
18+
19+
- Some info
20+
- Some other into
21+
- Some sub info
22+
23+
### Section One Subsection
24+
25+
***
26+
27+
## Section Two
28+
29+
- Info
30+
- Info 2
31+
32+
!!! Tip
33+
This is a tip.

0 commit comments

Comments
 (0)