Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions src/config/sidebarConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -309,15 +309,16 @@ export const sidebarSections: Record<string, SidebarSection[]> = {
],

// Resources section (content lives at /resources but navbar says "Other Resources")
// '/resources': [
// {
// label: 'Resources',
// items: [
// { label: 'Overview', slug: 'resources' },
// { label: 'Glossary', slug: 'resources/glossary' },
// ],
// },
// ],
'/resources': [
{
label: 'Resources',
items: [
{ label: 'Overview', slug: 'resources' },
{ label: 'Glossary', slug: 'resources/glossary' },
{ label: 'Docs', slug: 'resources/docs' },
],
},
],
};

/**
Expand Down
43 changes: 43 additions & 0 deletions src/content/docs/resources/docs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Docs
description: Links to helpful docs for FRC programming
---

Here are some links to helpful documentation that you might reference while programming FRC robot code.

## Libraries
Comment thread
reniejoshi marked this conversation as resolved.

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 would be a good idea to split this between vendor/hardware libraries and like pure software libraries but idk


| Name | Docs Site | API Docs |
| :---------------------- | :-------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
| WPILib | https://docs.wpilib.org/en/latest/ | https://github.wpilib.org/allwpilib/docs/2027/java/index.html |
| Phoenix 6 | https://v6.docs.ctr-electronics.com/en/stable/ | https://api.ctr-electronics.com/phoenix6/stable/java/ |
| REVLib | https://docs.revrobotics.com/revlib | https://codedocs.revrobotics.com/java/com/revrobotics/package-summary.html |
| Redux | https://docs.reduxrobotics.com/reduxlib/ | https://apidocs.reduxrobotics.com/current/java/ |
| Kauailabs’ NavX Library | https://pdocs.kauailabs.com/navx-mxp/software/roborio-libraries/java/ | https://www.kauailabs.com/public_files/navx-mxp/apidocs/java/index.html |
| Studica’s Titan Library | https://docs.dev.studica.com/en/latest/docs/GettingStarted/index.html | https://dev.studica.com/releases/JavaAPIDocs/index.html |
| Limelight | https://docs.limelightvision.io/docs/docs-limelight/getting-started/summary | https://limelightlib-wpijava-reference.limelightvision.io/frc/robot/package-summary.html |
| PhotonVision | https://docs.photonvision.org/en/latest/index.html | https://javadocs.photonvision.org/release/ |
| PathPlannerLib | https://pathplanner.dev/pathplannerlib.html | https://pathplanner.dev/api/java/ |
| ChoreoLib | https://choreo.autos/choreolib/getting-started/ | https://choreo.autos/api/choreolib/java/index.html |
Comment thread
reniejoshi marked this conversation as resolved.

## Version Control
Comment thread
reniejoshi marked this conversation as resolved.

| Name | Docs Site |
| :------------------------- | :------------------------------------------------------------ |
| Git | https://git-scm.com/ |
| GitHub | https://docs.github.com/en |
| Version Control in VS Code | https://code.visualstudio.com/docs/introvideos/versioncontrol |
| GitHub Desktop | https://github.com/apps/desktop |

## IDE

| Name | Docs Site |
| :------ | :--------------------------------- |
| VS Code | https://code.visualstudio.com/docs |

## Logging

| Name | Docs Site | API Docs |
| :----------- | :----------------------------- | :----------------------------------------------- |
| AdvantageKit | https://docs.advantagekit.org/ | https://docs.advantagekit.org/javadoc/index.html |
| DogLog | https://doglog.dev/ | https://javadoc.doglog.dev/ |
1 change: 1 addition & 0 deletions src/starlightOverrides/Header.astro
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ const navLinks = [
{ href: '/learning-course/', label: 'Learning Course' },
{ href: '/educators-guide/introduction/', label: "Educator's Guide" },
{ href: '/best-practices/overview', label: 'Best Practices' },
{ href: '/resources/docs', label: 'Other Resources' }, // TODO: update to '/resources/overview' after merging pr #104
{ href: '/contribution/', label: 'Contribution' },
];

Expand Down