Skip to content

Add hardware intro and resources overview pages - #104

Open
reniejoshi wants to merge 31 commits into
frcsoftware:mainfrom
reniejoshi:hardware-intro
Open

Add hardware intro and resources overview pages#104
reniejoshi wants to merge 31 commits into
frcsoftware:mainfrom
reniejoshi:hardware-intro

Conversation

@reniejoshi

@reniejoshi reniejoshi commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Description

Add hardware intro page that briefly covers motors, encoders, and gyroscopes for programmers, including code snippets showing common use cases. This serves to introduce programmers to basic hardware components that they will encounter in writing FRC robot code. Closes #23.

Add overview page for resources navigation with styles and visual components similar to FRCDesign.org.

Meta

Merge checklist:

@github-actions

Copy link
Copy Markdown

🌐 Preview URL: https://pr-104.frcsoftware.pages.dev

@reniejoshi reniejoshi changed the title Add hardware intro page Add hardware intro and resources overview pages Jul 20, 2026
Comment thread examples/resources/src/main/java/sources/HardwareIntro.java
@Spaceman113138

Copy link
Copy Markdown
Contributor

I would make a distinction between absolute and relative encoders.

@roboteer5291 roboteer5291 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like what you've written, but I think some reconsideration on the purpose of this section would be good. It feels like a weird mix between resources, best practices, and teaching. I think we'd be best served to keep this section as much of resources as possible, since best practices and teaching already have a home within the learning course (and best practices may get their own section, tbd).

I also think that it'd be wise to include the distinction of encoder types from a software functionality perspective as mentioned, and to also include mention of beam breaks/retroreflective sensors and distance sensors (noting that those are most commonly used as a beam break-esque sensor).

Comment thread src/content/docs/resources/hardware-intro.mdx
Comment thread src/content/docs/resources/hardware-intro.mdx Outdated
Comment thread src/content/docs/resources/hardware-intro.mdx Outdated
@github-actions github-actions Bot added Curriculum material Curriculum materials, lessons for students, etc examples labels Jul 22, 2026
@samfreund
samfreund requested a review from a team as a code owner July 22, 2026 18:09
@reniejoshi reniejoshi mentioned this pull request Jul 26, 2026
3 tasks

@Daniel1464 Daniel1464 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey Renie, I realized that the CI wasn't compiling your code snippets properly, so I opened PR #139 to fix it. So, I would suggest merging in that change once PR #139 gets merged in.

The code looks mostly good, but you do need to explicitly define the ExampleMotor and ExampleEncoder classes, and add some missing imports.

zachwaffle4 pushed a commit that referenced this pull request Jul 27, 2026
## Description

I noticed that in PR #104, the resources snippets subdirectory wasn't
being compiled properly. This changes examples.gradle to be more
flexible in it's subrepo search.

## Meta

Merge checklist:

- [x] Pull Request title is [short, imperative
summary](https://cbea.ms/git-commit/) of proposed changes
- [x] The description documents the _what_ and _why_, including events
that led to this PR
- [x] Pull Request has been [linted and
formatted](https://frcsoftware.org/contribution/styleguide/#linting-and-formatting)
and follows the
[styleguide](https://frcsoftware.org/contribution/styleguide)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Curriculum material Curriculum materials, lessons for students, etc examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Hardware Intro

6 participants