Skip to content

Create Educator's Guide#36

Open
roboteer5291 wants to merge 23 commits into
frcsoftware:mainfrom
roboteer5291:educators-guide
Open

Create Educator's Guide#36
roboteer5291 wants to merge 23 commits into
frcsoftware:mainfrom
roboteer5291:educators-guide

Conversation

@roboteer5291

@roboteer5291 roboteer5291 commented Jun 19, 2026

Copy link
Copy Markdown
Collaborator

Working PR. Creates educator's guide. Addresses #35

@roboteer5291 roboteer5291 marked this pull request as draft June 20, 2026 03:20
Comment thread src/content/docs/educators-guide/introduction/index.mdx
Comment thread src/content/docs/educators-guide/introduction/index.mdx Outdated
@samfreund samfreund force-pushed the main branch 9 times, most recently from b5680fd to 6ca05c8 Compare June 25, 2026 06:58
Comment thread src/content/docs/educators-guide/introduction/index.mdx Outdated
Comment thread src/content/docs/educators-guide/introduction/the-stages.mdx Outdated
@github-actions

Copy link
Copy Markdown

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

@roboteer5291 roboteer5291 marked this pull request as ready for review June 27, 2026 01:39
DylanB5402
DylanB5402 previously approved these changes Jun 27, 2026

@DylanB5402 DylanB5402 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

A couple typos and something to think about, but nothing blocking approval. Looks good, I like what we're going for here.

Comment thread src/content/docs/educators-guide/introduction/index.mdx Outdated
Comment thread src/content/docs/educators-guide/introduction/preparation.mdx Outdated
Comment thread src/content/docs/educators-guide/introduction/preparation.mdx Outdated
This includes heavy utilization of simulation to develop and validate code, structuring code to be both quick to write and easy to make changes and maintain in-season, and giving students the tools to evaluate when certain control strategies may be necessary or whether a simpler, but easier, strategy is appropriate.

There are infinitely many ways to structure a robot project or control a mechanism, but this course gives what its writers believe to be the best balance of simplicity, maintainability, and capability.
As such, how your team wrote code in the past isn't necessarily incorrect, it's just not how this course will be teaching.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I wonder if it's worth mentioning something like even if you intend to teach your team to structure code differently, FRCSoftware resources can still be leveraged to accomplish that (say starting with our Stage 2 starter code and writing a version of that using a team's custom framework while leveraging the sim we shipped with the starter code).

Happy to treat this more as something to think about than something to include immediately

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I like that idea, but I'd be hesitant to mention that before we know what the stage 2 code is going to look like and what the guides behind it are going to look like as well. Depending on how things are written, it could be really weird to work around a different structure. For the time being I think it's probably best to hold off, but keep in mind once we have a better picture of what a complete stage 2 is going to look like.

Comment thread src/content/docs/educators-guide/introduction/index.mdx Outdated

Additionally, there are various reference sections that don't fall on the main Learning Course.
These cover topics that are relevant to FRC programming, such as swerve or vision, but aren't necessarily the core concepts that need to be taught to allow a student to meaningfully contribute in-season.
Generally, these topics are something only one student on a programming subteam would need to know, while the Learning Course focuses on the concepts every student will want to know to effectively contribute.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
Generally, these topics are something only one student on a programming subteam would need to know, while the Learning Course focuses on the concepts every student will want to know to effectively contribute.
Generally, these topics are something that a core group of students on a programming subteam would need to know, while the Learning Course focuses on the concepts every student will want to know to effectively contribute.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think more than one student should know vision or swerve

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

How would you feel about "...are something that only a core group of students on a programming subteam..." (emphasis would not be in final version)?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Sounds good!

Comment thread src/content/docs/educators-guide/introduction/index.mdx Outdated
Comment thread src/content/docs/educators-guide/introduction/index.mdx Outdated
Comment thread src/content/docs/educators-guide/introduction/preparation.mdx Outdated
roboteer5291 and others added 2 commits June 27, 2026 17:00
Co-authored-by: Adriana  <adrianammassie@gmail.com>
Co-authored-by: Adriana  <adrianammassie@gmail.com>
Comment thread src/content/docs/educators-guide/introduction/index.mdx Outdated
Comment thread src/content/docs/educators-guide/introduction/index.mdx
Comment thread src/content/docs/educators-guide/introduction/index.mdx Outdated
This includes heavy utilization of simulation to develop and validate code, structuring code to be both quick to write and easy to make changes and maintain in-season, and giving students the tools to evaluate when certain control strategies may be necessary or whether a simpler, but easier, strategy is appropriate.

There are infinitely many ways to structure a robot project or control a mechanism, but this course gives what its writers believe to be the best balance of simplicity, maintainability, and capability.
As such, how your team wrote code in the past isn't necessarily incorrect, it's just not how this course will be teaching.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I like that idea, but I'd be hesitant to mention that before we know what the stage 2 code is going to look like and what the guides behind it are going to look like as well. Depending on how things are written, it could be really weird to work around a different structure. For the time being I think it's probably best to hold off, but keep in mind once we have a better picture of what a complete stage 2 is going to look like.

Comment thread src/content/docs/educators-guide/introduction/index.mdx Outdated

Additionally, there are various reference sections that don't fall on the main Learning Course.
These cover topics that are relevant to FRC programming, such as swerve or vision, but aren't necessarily the core concepts that need to be taught to allow a student to meaningfully contribute in-season.
Generally, these topics are something only one student on a programming subteam would need to know, while the Learning Course focuses on the concepts every student will want to know to effectively contribute.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

How would you feel about "...are something that only a core group of students on a programming subteam..." (emphasis would not be in final version)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants