docs: refactor GitHub Action documentation#327
Merged
Conversation
- Rewrite Overview, Configuration Reference, and External Mode pages - Add Quick Start Guide consolidating demo walkthrough and setup steps - Remove demo-autograder.md (content merged into quick-start.md) - Consolidate external-mode-rollout guide into external-mode.md - Update mkdocs nav to include all GitHub Action pages
Contributor
There was a problem hiding this comment.
Pull request overview
Refactors the GitHub Action documentation into a clearer multi-page set (overview, quick start, configuration reference, and external mode) and updates the MkDocs navigation accordingly.
Changes:
- Reorganized GitHub Action docs into 4 primary pages and expanded content/structure.
- Added a new Quick Start Guide and removed the standalone demo walkthrough page (content merged).
- Updated MkDocs navigation to reflect the new GitHub Action documentation layout.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Updates docs navigation to include the new GitHub Action pages. |
| docs/github_action/README.md | Rewritten GitHub Action overview with architecture, modes, and quick references. |
| docs/github_action/quick-start.md | New end-to-end setup guide for repo and external execution modes. |
| docs/github_action/external-mode.md | Expanded external mode deep dive including payloads, setup, checklist, and troubleshooting. |
| docs/github_action/demo-autograder.md | Removed (demo walkthrough content moved into Quick Start). |
| docs/github_action/configuration.md | Expanded configuration reference for inputs/outputs/secrets/permissions and validation rules. |
Comments suppressed due to low confidence (2)
docs/github_action/quick-start.md:52
- This CSS test example also uses
file: "submission/styles.css", but submission files are keyed relative to thesubmission/directory (so this should bestyles.css). As written, the file target won't resolve and the test may run with empty/None content.
"tests": [
{
"file": "submission/styles.css",
"name": "check_flexbox_usage"
}
docs/github_action/external-mode.md:298
- This smoke-test step says results appear at
GET /api/v1/submissions/config/42, but that endpoint doesn't exist in the current API implementation. Please update the verification instructions to use an actual submissions read endpoint (e.g., by user or by submission id).
### 2. Trigger a test run
Push a known-good submission. Verify:
- Action completes successfully
- Result appears: `GET /api/v1/submissions/config/42`
Comment on lines
+35
to
+39
| { | ||
| "file": "submission/index.html", | ||
| "name": "has_tag", | ||
| "parameters": [ | ||
| { "name": "tag", "value": "header" }, |
| Push a submission and check: | ||
|
|
||
| - ✅ The workflow completes without errors | ||
| - ✅ A result appears on `GET /api/v1/submissions/config/42` |
Comment on lines
+75
to
+79
| Key fields: | ||
|
|
||
| - `test_library` — which template library to use (`web_dev`, `input_output`, `api_testing`) | ||
| - `base.subjects` — hierarchical tree of subjects, each with `weight` and either `subjects` (children) or `tests` | ||
| - Each test specifies `file`, `name` (test function), and optional `parameters` |
| | `webdev` | HTML/CSS/JS | Web development assignments (DOM, CSS, structure) | | ||
| | `input_output` | Python, Java, C++ | Standard I/O programs with test cases | | ||
| | `api` | Any | REST API endpoint testing | | ||
|
|
Comment on lines
+225
to
+229
| Push a submission and check: | ||
|
|
||
| ```bash | ||
| curl -H "Authorization: Bearer $TOKEN" \ | ||
| https://your-cloud-url/api/v1/submissions/config/42 |
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.
Summary
Refactors the GitHub Action documentation into a comprehensive, well-structured set of pages:
Changes
quick-start.mdconsolidating the demo walkthrough and setup instructionsdemo-autograder.md(content merged into quick-start)What was tested