From 2c235c557f5b572ae27da1116249fec3bf488e2c Mon Sep 17 00:00:00 2001 From: Renie Joshi Date: Wed, 22 Jul 2026 13:09:05 -0700 Subject: [PATCH 1/8] Add docs page --- src/config/sidebarConfig.ts | 19 ++++++------ src/content/docs/resources/docs.mdx | 47 +++++++++++++++++++++++++++++ src/starlightOverrides/Header.astro | 1 + 3 files changed, 58 insertions(+), 9 deletions(-) create mode 100644 src/content/docs/resources/docs.mdx diff --git a/src/config/sidebarConfig.ts b/src/config/sidebarConfig.ts index 3e31facc..a15df80c 100644 --- a/src/config/sidebarConfig.ts +++ b/src/config/sidebarConfig.ts @@ -257,15 +257,16 @@ export const sidebarSections: Record = { ], // 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' }, + ], + }, + ], }; /** diff --git a/src/content/docs/resources/docs.mdx b/src/content/docs/resources/docs.mdx new file mode 100644 index 00000000..3b19daa1 --- /dev/null +++ b/src/content/docs/resources/docs.mdx @@ -0,0 +1,47 @@ +--- +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 + +| 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 | +| 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 | +| 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 | + +## Version Control + +| 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 | + +## 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 | +| tinylog | https://tinylog.org/ | https://tinylog.org/javadoc/ | + +## Simulation + +| Name | Docs Site | +| :------------ | :--------------------------------------------------------- | ------------------------------------------------------------ | +| MapleSim | https://shenzhen-robotics-alliance.github.io/maple-sim/ | +| dyn4j | https://dyn4j.org/ | https://www.javadoc.io/doc/org.dyn4j/dyn4j/latest/index.html | +| jMonkeyEngine | https://wiki.jmonkeyengine.org/docs/3.9/documentation.html | https://javadoc.jmonkeyengine.org/v3.9.0-stable/index.html | diff --git a/src/starlightOverrides/Header.astro b/src/starlightOverrides/Header.astro index d3861413..832fbaf5 100644 --- a/src/starlightOverrides/Header.astro +++ b/src/starlightOverrides/Header.astro @@ -12,6 +12,7 @@ const navLinks = [ { href: '/', label: 'Home' }, { href: '/learning-course/', label: 'Learning Course' }, { href: '/educators-guide/introduction/', label: "Educator's Guide" }, + { href: '/resources', label: 'Other Resources' }, { href: '/contribution/', label: 'Contribution' }, ]; From 7f28a5405e2f5f4be6f3ae8c7121a9f65989e3d4 Mon Sep 17 00:00:00 2001 From: Renie Joshi Date: Wed, 22 Jul 2026 13:41:06 -0700 Subject: [PATCH 2/8] Add docs for vision libraries --- src/content/docs/resources/docs.mdx | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/src/content/docs/resources/docs.mdx b/src/content/docs/resources/docs.mdx index 3b19daa1..ee8115c4 100644 --- a/src/content/docs/resources/docs.mdx +++ b/src/content/docs/resources/docs.mdx @@ -7,15 +7,17 @@ Here are some links to helpful documentation that you might reference while prog ## Libraries -| 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 | -| 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 | -| 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 | +| 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 | +| 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 | ## Version Control From 67858e83e2f0522d4c497190a0f35eb32175e7d0 Mon Sep 17 00:00:00 2001 From: Renie Joshi Date: Wed, 22 Jul 2026 14:34:58 -0700 Subject: [PATCH 3/8] Add DogLog to docs --- src/content/docs/resources/docs.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/src/content/docs/resources/docs.mdx b/src/content/docs/resources/docs.mdx index ee8115c4..65af2f03 100644 --- a/src/content/docs/resources/docs.mdx +++ b/src/content/docs/resources/docs.mdx @@ -39,6 +39,7 @@ Here are some links to helpful documentation that you might reference while prog | :----------- | :----------------------------- | :----------------------------------------------- | | AdvantageKit | https://docs.advantagekit.org/ | https://docs.advantagekit.org/javadoc/index.html | | tinylog | https://tinylog.org/ | https://tinylog.org/javadoc/ | +| DogLog | https://doglog.dev/ | https://javadoc.doglog.dev/ | ## Simulation From 18e45481274270ebe46663e1b54ac5afe5b4ab27 Mon Sep 17 00:00:00 2001 From: Renie Joshi Date: Sat, 25 Jul 2026 15:35:09 -0700 Subject: [PATCH 4/8] Implement requested changes --- src/content/docs/resources/docs.mdx | 10 ++++------ src/starlightOverrides/Header.astro | 2 +- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/src/content/docs/resources/docs.mdx b/src/content/docs/resources/docs.mdx index 65af2f03..6316ebf5 100644 --- a/src/content/docs/resources/docs.mdx +++ b/src/content/docs/resources/docs.mdx @@ -12,6 +12,7 @@ Here are some links to helpful documentation that you might reference while prog | 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 | @@ -38,13 +39,10 @@ Here are some links to helpful documentation that you might reference while prog | Name | Docs Site | API Docs | | :----------- | :----------------------------- | :----------------------------------------------- | | AdvantageKit | https://docs.advantagekit.org/ | https://docs.advantagekit.org/javadoc/index.html | -| tinylog | https://tinylog.org/ | https://tinylog.org/javadoc/ | | DogLog | https://doglog.dev/ | https://javadoc.doglog.dev/ | ## Simulation -| Name | Docs Site | -| :------------ | :--------------------------------------------------------- | ------------------------------------------------------------ | -| MapleSim | https://shenzhen-robotics-alliance.github.io/maple-sim/ | -| dyn4j | https://dyn4j.org/ | https://www.javadoc.io/doc/org.dyn4j/dyn4j/latest/index.html | -| jMonkeyEngine | https://wiki.jmonkeyengine.org/docs/3.9/documentation.html | https://javadoc.jmonkeyengine.org/v3.9.0-stable/index.html | +| Name | Docs Site | +| :------- | :------------------------------------------------------ | +| MapleSim | https://shenzhen-robotics-alliance.github.io/maple-sim/ | diff --git a/src/starlightOverrides/Header.astro b/src/starlightOverrides/Header.astro index a0715777..3f1c74d1 100644 --- a/src/starlightOverrides/Header.astro +++ b/src/starlightOverrides/Header.astro @@ -13,7 +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', label: 'Other Resources' }, + { href: '/resources/docs', label: 'Other Resources' }, { href: '/contribution/', label: 'Contribution' }, ]; From b3e68aac552973546b2b40a4c3250ee8d56ca6d7 Mon Sep 17 00:00:00 2001 From: Renie Joshi Date: Sat, 25 Jul 2026 16:49:51 -0700 Subject: [PATCH 5/8] Remove simulation docs --- src/content/docs/resources/docs.mdx | 6 ------ 1 file changed, 6 deletions(-) diff --git a/src/content/docs/resources/docs.mdx b/src/content/docs/resources/docs.mdx index 6316ebf5..f92a4881 100644 --- a/src/content/docs/resources/docs.mdx +++ b/src/content/docs/resources/docs.mdx @@ -40,9 +40,3 @@ Here are some links to helpful documentation that you might reference while prog | :----------- | :----------------------------- | :----------------------------------------------- | | AdvantageKit | https://docs.advantagekit.org/ | https://docs.advantagekit.org/javadoc/index.html | | DogLog | https://doglog.dev/ | https://javadoc.doglog.dev/ | - -## Simulation - -| Name | Docs Site | -| :------- | :------------------------------------------------------ | -| MapleSim | https://shenzhen-robotics-alliance.github.io/maple-sim/ | From 471682e53c7731f70b1f2659bf5ab506e7eb09fd Mon Sep 17 00:00:00 2001 From: Renie Joshi Date: Sat, 25 Jul 2026 17:13:27 -0700 Subject: [PATCH 6/8] Add GitHub Desktop docs --- src/content/docs/resources/docs.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/src/content/docs/resources/docs.mdx b/src/content/docs/resources/docs.mdx index f92a4881..1396ed3c 100644 --- a/src/content/docs/resources/docs.mdx +++ b/src/content/docs/resources/docs.mdx @@ -27,6 +27,7 @@ Here are some links to helpful documentation that you might reference while prog | 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 From e5d804686bc8d8019292e7b2490d9978bdc2adf2 Mon Sep 17 00:00:00 2001 From: Renie Joshi Date: Sat, 25 Jul 2026 17:21:21 -0700 Subject: [PATCH 7/8] Add todo comment --- src/starlightOverrides/Header.astro | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/starlightOverrides/Header.astro b/src/starlightOverrides/Header.astro index 3f1c74d1..47496c9b 100644 --- a/src/starlightOverrides/Header.astro +++ b/src/starlightOverrides/Header.astro @@ -13,7 +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' }, + { href: '/resources/docs', label: 'Other Resources' }, // TODO: update to '/resources/overview' after merging pr #104 { href: '/contribution/', label: 'Contribution' }, ]; From 6f083123157490eb011f11664dfdc065db64b6f4 Mon Sep 17 00:00:00 2001 From: Renie Joshi Date: Sun, 26 Jul 2026 12:25:55 -0700 Subject: [PATCH 8/8] Refactor libraries docs organization --- src/content/docs/resources/docs.mdx | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/src/content/docs/resources/docs.mdx b/src/content/docs/resources/docs.mdx index 1396ed3c..b06a7630 100644 --- a/src/content/docs/resources/docs.mdx +++ b/src/content/docs/resources/docs.mdx @@ -5,11 +5,10 @@ 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 +## Vendor Libraries | 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/ | @@ -17,8 +16,14 @@ Here are some links to helpful documentation that you might reference while prog | 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 | + +## Software Libraries + +| Name | Docs Site | API Docs | +| :------------- | :---------------------------------------------- | :------------------------------------------------------------ | +| WPILib | https://docs.wpilib.org/en/latest/ | https://github.wpilib.org/allwpilib/docs/2027/java/index.html | +| 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 | ## Version Control