Skip to content

[Documentation:System] Add config include docs#745

Open
vimla01 wants to merge 1 commit intoSubmitty:mainfrom
vimla01:issue-11551-docs
Open

[Documentation:System] Add config include docs#745
vimla01 wants to merge 1 commit intoSubmitty:mainfrom
vimla01:issue-11551-docs

Conversation

@vimla01
Copy link
Copy Markdown

@vimla01 vimla01 commented Mar 29, 2026

Why is this Change Important & Necessary?

Partially addresses Submitty/Submitty#11551

Autograding configs support C/C++ comments and #include, but that workflow was not clearly documented on submitty.org.

What is the New Behavior?

This PR updates the instructor docs to:

  • document #include support in config.json
  • explain how to upload multi-file configs
  • mention generated/preprocessed config files for debugging line-number errors
  • link to the new multi-file example in the Submitty repo

What steps should a reviewer take to reproduce or test the bug or new feature?

  1. Review the updated autograding specification page.
  2. Review the updated configuration path page.
  3. Confirm the new text clearly explains multi-file configs and debugging guidance.

Automated Testing & Documentation

This PR updates submitty.org documentation for #11551.

Other information

  • No migrations required
  • Not a breaking change
  • This PR pairs with #12686 and #12687

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Seeking Reviewer

Development

Successfully merging this pull request may close these issues.

1 participant