Conversation
…folder Agent-Logs-Url: https://github.com/Spectrum3847/2026-Spectrum/sessions/f70f3e53-284d-462c-a791-e591f1b584ad Co-authored-by: Project516 <138796702+Project516@users.noreply.github.com>
…docs Update javadoc.yml: deploy docs as root with javadocs in /javadoc sub…
this is where they will be if this is merged Co-Authored-By: project516 <138796702+Project516@users.noreply.github.com>
Project516
added
documentation
There was a problem hiding this comment.
Pull request overview
Updates the GitHub Pages deployment so the repository’s Markdown docs are published at the site root while generated JavaDocs are published under a /javadoc subdirectory, and refreshes documentation links accordingly.
Changes:
- Deploy
docs/contents alongside generated JavaDocs to GitHub Pages (JavaDocs under/javadoc). - Add/update links pointing to the new JavaDocs location.
- Minor comment whitespace/wrapping cleanup in Java sources.
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
src/main/java/frc/robot/swerve/Swerve.java |
Wraps a JavaDoc comment for formatting consistency. |
src/main/java/frc/robot/leds/LedStates.java |
Removes trailing whitespace in a commented JavaDoc block. |
docs/index.md |
Adds a prominent link to the hosted JavaDocs. |
README.md |
Updates the JavaDocs URL to include /javadoc. |
.github/workflows/javadoc.yml |
Stages docs/ + generated JavaDocs and deploys both to GitHub Pages. |
|
|
||
| Welcome to the documentation for Spectrum's 2026 robot code, developed for the FRC game season REBUILT. This guide is designed to help new programmers get up to speed with our codebase, understand core FRC concepts, and learn about our development practices. | ||
|
|
||
| **Looking for the online javadocs? View them [here](/javadoc).** |
There was a problem hiding this comment.
The /javadoc link is root-absolute, which will resolve to https://spectrum3847.github.io/javadoc on GitHub project pages. Use a relative link (e.g., javadoc/ or ./javadoc) so it works under /2026-Spectrum/ and also in local previews.
| **Looking for the online javadocs? View them [here](/javadoc).** | |
| **Looking for the online javadocs? View them [here](javadoc/).** |
| run: ./gradlew javadoc | ||
|
|
||
| - name: Prepare Pages content | ||
| run: | | ||
| mkdir -p staging/javadoc |
There was a problem hiding this comment.
./gradlew javadoc is invoked without first ensuring gradlew is executable. The CI workflow includes a chmod +x gradlew step; adding the same step here would prevent Pages deploy failures when the executable bit isn’t preserved on checkout.
this will move the javadocs to the javadoc directory. this pr updates the workflows to carry this out, and updates the location to the javadocs in the documentation.