Skip to content

Add examples page - #164

Open
reniejoshi wants to merge 11 commits into
frcsoftware:mainfrom
reniejoshi:add-examples-page
Open

Add examples page#164
reniejoshi wants to merge 11 commits into
frcsoftware:mainfrom
reniejoshi:add-examples-page

Conversation

@reniejoshi

@reniejoshi reniejoshi commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Description

Creates the examples section featuring code analysis of three robot code repos. This section has a similar appearance and structure to the corresponding FRCDesign.org section.

Closes #89.

Meta

Merge checklist:

@github-actions github-actions Bot added the Curriculum material Curriculum materials, lessons for students, etc label Aug 1, 2026
@github-actions

github-actions Bot commented Aug 1, 2026

Copy link
Copy Markdown

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

Comment thread src/content/docs/examples/index.mdx Outdated
Comment thread src/content/docs/examples/index.mdx
Comment thread src/config/sidebarConfig.ts
@Adrianamm

Copy link
Copy Markdown
Member

Since the (non kitbot) examples already have docs, CD post etc with explanations of their code. It's probably best to just link directly to it rather than try to re-explain or rewrite docs. This makes it easier to cite sources and links teams directly to good resources. The change could be as simple as adding links each robot's "box" like this
image

@reniejoshi
reniejoshi marked this pull request as ready for review September 1, 2026 04:17
@reniejoshi
reniejoshi requested a review from Adrianamm September 1, 2026 04:17

@Adrianamm Adrianamm 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.

Just one suggestion. It looks great!

Comment on lines +57 to +65
<section class="examples-hero">
<div class="examples-hero-copy">
<p class="examples-eyebrow">Repository examples</p>
<p class="hero-copy">
Don't be afraid to take inspiration from robot code that already solved hard programming problems.
This library collects code analysis and repositories so teams can study real examples, compare approaches, and build better code faster.
</p>
</div>
</section>

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
<section class="examples-hero">
<div class="examples-hero-copy">
<p class="examples-eyebrow">Repository examples</p>
<p class="hero-copy">
Don't be afraid to take inspiration from robot code that already solved hard programming problems.
This library collects code analysis and repositories so teams can study real examples, compare approaches, and build better code faster.
</p>
</div>
</section>
<p>
Don't be afraid to take inspiration from robot code that already solved hard programming problems.
This library collects code analysis and repositories so teams can study real examples, compare approaches, and build better code faster.
</p>

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.

The rest of the website doesn't put the first paragraph in a box. So I think it helps the page match the rest better. I think that suggestion works?

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add examples page

2 participants