Skip to content

Commit 630b06c

Browse files
author
Deploy from CI
committed
Deploy 4029443 to gh-pages
0 parents  commit 630b06c

File tree

82 files changed

+14839
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+14839
-0
lines changed

‎.github/workflows/deploy.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Deploy
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
jobs:
8+
deploy:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
contents: write # To push a branch
12+
pull-requests: write # To create a PR from that branch
13+
steps:
14+
- uses: actions/checkout@v4
15+
with:
16+
fetch-depth: 0
17+
- name: Install latest mdbook
18+
run: |
19+
tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
20+
url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
21+
mkdir mdbook
22+
curl -sSL $url | tar -xz --directory=./mdbook
23+
echo `pwd`/mdbook >> $GITHUB_PATH
24+
- name: Deploy GitHub Pages
25+
run: |
26+
# This assumes your book is in the root of your repository.
27+
# Just add a `cd` here if you need to change to another directory.
28+
mdbook build
29+
git worktree add gh-pages
30+
git config user.name "Deploy from CI"
31+
git config user.email ""
32+
cd gh-pages
33+
# Delete the ref to avoid keeping history.
34+
git update-ref -d refs/heads/gh-pages
35+
rm -rf *
36+
mv ../book/* .
37+
git add .
38+
git commit -m "Deploy $GITHUB_SHA to gh-pages"
39+
git push --force --set-upstream origin gh-pages

‎.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
book
2+
book/*
3+
4+
.DS_Store
5+
**/.DS_Store

‎.idea/.gitignore

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/cookbook.iml

Lines changed: 12 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/modules.xml

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/vcs.xml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎404.html

Lines changed: 218 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,218 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en" class="light" dir="ltr">
3+
<head>
4+
<!-- Book generated using mdBook -->
5+
<meta charset="UTF-8">
6+
<title>Page not found - The Cookbook</title>
7+
<base href="/">
8+
9+
10+
<!-- Custom HTML head -->
11+
12+
<meta name="description" content="">
13+
<meta name="viewport" content="width=device-width, initial-scale=1">
14+
<meta name="theme-color" content="#ffffff">
15+
16+
<link rel="icon" href="favicon.svg">
17+
<link rel="shortcut icon" href="favicon.png">
18+
<link rel="stylesheet" href="css/variables.css">
19+
<link rel="stylesheet" href="css/general.css">
20+
<link rel="stylesheet" href="css/chrome.css">
21+
<link rel="stylesheet" href="css/print.css" media="print">
22+
23+
<!-- Fonts -->
24+
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
25+
<link rel="stylesheet" href="fonts/fonts.css">
26+
27+
<!-- Highlight.js Stylesheets -->
28+
<link rel="stylesheet" href="highlight.css">
29+
<link rel="stylesheet" href="tomorrow-night.css">
30+
<link rel="stylesheet" href="ayu-highlight.css">
31+
32+
<!-- Custom theme stylesheets -->
33+
34+
</head>
35+
<body class="sidebar-visible no-js">
36+
<div id="body-container">
37+
<!-- Provide site root to javascript -->
38+
<script>
39+
var path_to_root = "";
40+
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
41+
</script>
42+
43+
<!-- Work around some values being stored in localStorage wrapped in quotes -->
44+
<script>
45+
try {
46+
var theme = localStorage.getItem('mdbook-theme');
47+
var sidebar = localStorage.getItem('mdbook-sidebar');
48+
49+
if (theme.startsWith('"') && theme.endsWith('"')) {
50+
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
51+
}
52+
53+
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
54+
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
55+
}
56+
} catch (e) { }
57+
</script>
58+
59+
<!-- Set the theme before any content is loaded, prevents flash -->
60+
<script>
61+
var theme;
62+
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
63+
if (theme === null || theme === undefined) { theme = default_theme; }
64+
var html = document.querySelector('html');
65+
html.classList.remove('light')
66+
html.classList.add(theme);
67+
var body = document.querySelector('body');
68+
body.classList.remove('no-js')
69+
body.classList.add('js');
70+
</script>
71+
72+
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
73+
74+
<!-- Hide / unhide sidebar before it is displayed -->
75+
<script>
76+
var body = document.querySelector('body');
77+
var sidebar = null;
78+
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
79+
if (document.body.clientWidth >= 1080) {
80+
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
81+
sidebar = sidebar || 'visible';
82+
} else {
83+
sidebar = 'hidden';
84+
}
85+
sidebar_toggle.checked = sidebar === 'visible';
86+
body.classList.remove('sidebar-visible');
87+
body.classList.add("sidebar-" + sidebar);
88+
</script>
89+
90+
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
91+
<div class="sidebar-scrollbox">
92+
<ol class="chapter"><li class="chapter-item expanded affix "><a href="introduction.html">Introduction</a></li><li class="chapter-item expanded affix "><li class="part-title">Introduction to Programming</li><li class="chapter-item expanded "><a href="intro_to_programming/setup.html"><strong aria-hidden="true">1.</strong> Development Environment Setup</a></li><li class="chapter-item expanded affix "><li class="part-title">Road Runner 1.0</li><li class="chapter-item expanded "><a href="roadrunner_10/null_list_error_in_rr_10.html"><strong aria-hidden="true">2.</strong> Empty list error in Road Runner 1.0</a></li><li class="chapter-item expanded affix "><li class="part-title">Road Runner 0.5.6</li><li class="chapter-item expanded "><a href="roadrunner_056/is_the_bump_on_manual_feedforward_tuner_normal.html"><strong aria-hidden="true">3.</strong> Is the bump on feedforward tuner normal?</a></li><li class="chapter-item expanded "><a href="roadrunner_056/manual_feedforward_tuner_overshooots.html"><strong aria-hidden="true">4.</strong> Manual feedforward tuner overshoots</a></li><li class="chapter-item expanded "><a href="roadrunner_056/manual_feed_forward_tuner_opposite_velocities.html"><strong aria-hidden="true">5.</strong> Manual Feedforward tuner opposite velocity</a></li><li class="chapter-item expanded "><a href="roadrunner_056/robot_localization_makes_circle_when_spinning_in_place.html"><strong aria-hidden="true">6.</strong> Robot localization makes circles when spinning in place</a></li><li class="chapter-item expanded "><a href="roadrunner_056/robot_velocity_plateaus_below_target_velocity_plateau.html"><strong aria-hidden="true">7.</strong> Robot velocity plateaus below target velocity plateau</a></li><li class="chapter-item expanded "><a href="roadrunner_056/robot_drifts_to_one_side_during_manual_feedforward_tuning.html"><strong aria-hidden="true">8.</strong> Robot drifts to one side during feedforward tuning</a></li><li class="chapter-item expanded "><a href="roadrunner_056/robot_drifts_while_tuning_follower_pid.html"><strong aria-hidden="true">9.</strong> Robot drifts while tuning follower PID</a></li><li class="chapter-item expanded "><a href="roadrunner_056/robot_drives_full_speed_on_start_when_following_trajectory.html"><strong aria-hidden="true">10.</strong> Robot drives full speed on start when following trajectory</a></li><li class="chapter-item expanded "><a href="roadrunner_056/how_to_integrate_a_PIDF_controller_with_roadrunner/how_to_integrate_a_PIDF_controller_with_roadrunner.html"><strong aria-hidden="true">11.</strong> How to integrate a PIDF controller with Road Runner</a></li><li class="chapter-item expanded affix "><li class="part-title">Common Driver Station Error Messages</li><li class="chapter-item expanded "><a href="common_ds_errors/npe_at_init/npe_at_init.html"><strong aria-hidden="true">12.</strong> NullPointerException on initialization</a></li><li class="chapter-item expanded affix "><li class="part-title">PID(F) Controllers</li><li class="chapter-item expanded "><a href="pidf_controllers/integrating_a_custom_PIDF_controller.html"><strong aria-hidden="true">13.</strong> Integrating a Custom PID(F) Controller</a></li><li class="chapter-item expanded "><a href="pidf_controllers/syncing_two_linear_slide_motors_using_a_pidf_controller/syncing_two_linear_slide_motors_using_a_pidf_controller.html"><strong aria-hidden="true">14.</strong> Syncing two linear slide motors using a PID(F) Controller</a></li><li class="chapter-item expanded affix "><li class="part-title">Electrical</li><li class="chapter-item expanded "><a href="electrical/why_we_should_only_use_usb_30.html"><strong aria-hidden="true">15.</strong> Why to only use USB 3.0</a></li><li class="chapter-item expanded "><a href="electrical/how_to_wire_odometry_pods.html"><strong aria-hidden="true">16.</strong> How to wire odometry pods</a></li><li class="chapter-item expanded affix "><li class="part-title">Miscellaneous</li><li class="chapter-item expanded "><a href="misc/why_kotlin/why_kotlin.html"><strong aria-hidden="true">17.</strong> Why Kotlin?</a></li><li class="chapter-item expanded "><a href="misc/terminology_and_acronyms.html"><strong aria-hidden="true">18.</strong> Terminology and Acronyms</a></li><li class="chapter-item expanded "><a href="improving_loop_times/improving_loop_times.html"><strong aria-hidden="true">19.</strong> Improving Loop Times</a></li><li class="chapter-item expanded affix "><li class="spacer"></li><li class="chapter-item expanded affix "><a href="contributors.html">Contributors</a></li></ol>
93+
</div>
94+
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
95+
<div class="sidebar-resize-indicator"></div>
96+
</div>
97+
</nav>
98+
99+
<!-- Track and set sidebar scroll position -->
100+
<script>
101+
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
102+
sidebarScrollbox.addEventListener('click', function(e) {
103+
if (e.target.tagName === 'A') {
104+
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
105+
}
106+
}, { passive: true });
107+
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
108+
sessionStorage.removeItem('sidebar-scroll');
109+
if (sidebarScrollTop) {
110+
// preserve sidebar scroll position when navigating via links within sidebar
111+
sidebarScrollbox.scrollTop = sidebarScrollTop;
112+
} else {
113+
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
114+
var activeSection = document.querySelector('#sidebar .active');
115+
if (activeSection) {
116+
activeSection.scrollIntoView({ block: 'center' });
117+
}
118+
}
119+
</script>
120+
121+
<div id="page-wrapper" class="page-wrapper">
122+
123+
<div class="page">
124+
<div id="menu-bar-hover-placeholder"></div>
125+
<div id="menu-bar" class="menu-bar sticky">
126+
<div class="left-buttons">
127+
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
128+
<i class="fa fa-bars"></i>
129+
</label>
130+
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
131+
<i class="fa fa-paint-brush"></i>
132+
</button>
133+
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
134+
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
135+
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
136+
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
137+
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
138+
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
139+
</ul>
140+
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
141+
<i class="fa fa-search"></i>
142+
</button>
143+
</div>
144+
145+
<h1 class="menu-title">The Cookbook</h1>
146+
147+
<div class="right-buttons">
148+
<a href="print.html" title="Print this book" aria-label="Print this book">
149+
<i id="print-button" class="fa fa-print"></i>
150+
</a>
151+
152+
</div>
153+
</div>
154+
155+
<div id="search-wrapper" class="hidden">
156+
<form id="searchbar-outer" class="searchbar-outer">
157+
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
158+
</form>
159+
<div id="searchresults-outer" class="searchresults-outer hidden">
160+
<div id="searchresults-header" class="searchresults-header"></div>
161+
<ul id="searchresults">
162+
</ul>
163+
</div>
164+
</div>
165+
166+
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
167+
<script>
168+
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
169+
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
170+
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
171+
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
172+
});
173+
</script>
174+
175+
<div id="content" class="content">
176+
<main>
177+
<h1 id="document-not-found-404"><a class="header" href="#document-not-found-404">Document not found (404)</a></h1>
178+
<p>This URL is invalid, sorry. Please use the navigation bar or search to continue.</p>
179+
180+
</main>
181+
182+
<nav class="nav-wrapper" aria-label="Page navigation">
183+
<!-- Mobile navigation buttons -->
184+
185+
186+
<div style="clear: both"></div>
187+
</nav>
188+
</div>
189+
</div>
190+
191+
<nav class="nav-wide-wrapper" aria-label="Page navigation">
192+
193+
</nav>
194+
195+
</div>
196+
197+
198+
199+
200+
<script>
201+
window.playground_copyable = true;
202+
</script>
203+
204+
205+
<script src="elasticlunr.min.js"></script>
206+
<script src="mark.min.js"></script>
207+
<script src="searcher.js"></script>
208+
209+
<script src="clipboard.min.js"></script>
210+
<script src="highlight.js"></script>
211+
<script src="book.js"></script>
212+
213+
<!-- Custom JS scripts -->
214+
215+
216+
</div>
217+
</body>
218+
</html>

‎FontAwesome/css/font-awesome.css

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎FontAwesome/fonts/FontAwesome.ttf

162 KB
Binary file not shown.

‎FontAwesome/fonts/fontawesome-webfont.eot

162 KB
Binary file not shown.

0 commit comments

Comments
 (0)