Skip to content

docs: make getting started a real grading workflow#275

Merged
ArthurCRodrigues merged 2 commits into
mainfrom
getting-started-workflow-docs
Apr 12, 2026
Merged

docs: make getting started a real grading workflow#275
ArthurCRodrigues merged 2 commits into
mainfrom
getting-started-workflow-docs

Conversation

@ArthurCRodrigues

Copy link
Copy Markdown
Member

Summary

  • replace docs-first getting started page with a true first grading run
  • guide users through API startup, config creation, submission, and result retrieval
  • move MkDocs authoring instructions to a dedicated docs contributor guide
  • update MkDocs nav labels accordingly

Validation

  • python scripts/validate_docs.py
  • mkdocs build --strict

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 12, 2026 11:13
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

@ArthurCRodrigues ArthurCRodrigues left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the documentation “Getting Started” flow to walk users through a real end-to-end grading run (API start → config creation → submission → result retrieval), while moving MkDocs authoring instructions into a dedicated contributor guide.

Changes:

  • Replaced the previous “Local Docs Development” getting-started page with a first grading workflow quickstart.
  • Added a new “Docs Site Development (MkDocs)” guide for documentation contributors.
  • Updated MkDocs navigation labels/entries to reflect the new doc structure.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

File Description
mkdocs.yml Updates the MkDocs nav to surface the new getting-started workflow and adds the docs contributor guide to Guides.
docs/guides/docs-site-development.md New contributor-focused guide for running/building the docs site locally.
docs/getting-started/mkdocs-local-development.md Rewritten into a full first grading workflow quickstart (API/config/submission/results).

Comment on lines +22 to +28
When ready, the API is available at `http://localhost:8080`.

You can check health:

## Build locally
```bash
curl http://localhost:8080/api/v1/health
```

Copilot AI Apr 12, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The guide points to the API running on http://localhost:8080, but the Docker Compose service exposes port 8000 (docker-compose.yml maps 8000:8000 and healthcheck hits localhost:8000). This will cause the example curl commands to fail unless the user manually remaps ports. Please update the URLs/port throughout this page (or explicitly document how to configure the port).

Copilot uses AI. Check for mistakes.
Comment on lines +62 to +63
"required_files": ["main.py"],
"setup_commands": []

Copilot AI Apr 12, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

setup_config is shown as a flat object with required_files/setup_commands, but the runtime pre-flight code expects setup_config to be keyed by language (e.g., { "python": { "required_files": [...], "setup_commands": [...] } }). With the current example shape, the pre-flight step will not enforce main.py or run setup commands because it won’t find the language key.

Suggested change
"required_files": ["main.py"],
"setup_commands": []
"python": {
"required_files": ["main.py"],
"setup_commands": []
}

Copilot uses AI. Check for mistakes.
## 4) Poll for the result

```bash
curl http://localhost:8080/api/v1/submissions/<submission_id>

Copilot AI Apr 12, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In Markdown, the <submission_id> placeholder in the URL will be treated as an HTML tag and may not render as visible text. Use a non-angle-bracket placeholder (e.g., {submission_id} / SUBMISSION_ID) or escape the angle brackets so users can copy/paste the command correctly.

Suggested change
curl http://localhost:8080/api/v1/submissions/<submission_id>
curl http://localhost:8080/api/v1/submissions/{submission_id}

Copilot uses AI. Check for mistakes.
Comment thread mkdocs.yml
Comment on lines 40 to +42
- Getting Started:
- Local Docs Development: getting-started/mkdocs-local-development.md
- Run Your First Grading Workflow: getting-started/mkdocs-local-development.md
- Development Guide: guides/development.md

Copilot AI Apr 12, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page is now a grading-workflow quickstart, but the underlying filename/path is still getting-started/mkdocs-local-development.md, which is misleading for future maintenance and linkability. Consider renaming the markdown file/path to match the new topic (and update the nav entry accordingly).

Copilot uses AI. Check for mistakes.
@ArthurCRodrigues
ArthurCRodrigues merged commit 8f683c9 into main Apr 12, 2026
5 checks passed
@ArthurCRodrigues
ArthurCRodrigues deleted the getting-started-workflow-docs branch April 12, 2026 11:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants