deploy contents of docs to github pages#91
Open
Project516 wants to merge 5 commits intomainfrom
Open
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
SpectrumFRC3847
approved these changes
Apr 14, 2026
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. |
Comment on lines
25
to
+29
| 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.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
JediMasterLucy55
approved these changes
Apr 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.