Skip to content

Instructor Documentation with Notes and Edits#417

Merged
cycomachead merged 5 commits into
mainfrom
instructor-facing-documentation
Jul 2, 2026
Merged

Instructor Documentation with Notes and Edits#417
cycomachead merged 5 commits into
mainfrom
instructor-facing-documentation

Conversation

@coderNini

@coderNini coderNini commented May 23, 2026

Copy link
Copy Markdown
Contributor

UPDATE (6/4/2026)

  • See changes in Commit 5330190.

  • TWO IMPORTANT CHANGES FROM THIS COMMENT THAT I WASN'T ABLE TO MAKE MYSELF:

    • (1) Syncing Enrollments Section: The Enrollments tab doesn't appear to have a 'Sync Enrollments' button (see the comment for more details as to why this may or may not be an actual issue).

    • (2) Auto-Approval Settings Section: As stated in my comment, "The documentation states that [the 'Auto approve extended requests within days'] section exists to apply limitations for students with DSP accommodations, but the actual page on Flextensions says that it is to be used for 'students who have extenuating circumstances.' I'm not sure which is correct or the most-up-to-date."


General Info

  • I added detailed feedback and potential edits for current Instructor Documentation.
    - I'm happy to make these changes myself once my notes are reviewed!

Changes

Explain your changes here (in such a way that you would understand why you made them a year from now).
- No changes for now -- only notes

Testing

Explain how you tested your changes. If testing is not necessary, explain why.

  • N/A

Documentation

Does this PR require documentation. If so, explain where it can be found.

  • This PR is regarding existing documentation.

Added detailed feedback and potential edits for current Instructor Documentation. I'm happy to make these changes myself once my notes are reviewed!
@coderNini coderNini requested review from cycomachead and yanlisa May 23, 2026 02:25
@superconductor-for-github

superconductor-for-github Bot commented May 23, 2026

Copy link
Copy Markdown

@coderNiniSuperconductor finishedView implementation | App Preview


Standing by for instructions.

@coderNini

coderNini commented Jun 4, 2026

Copy link
Copy Markdown
Contributor Author

** Notes (below) from the MD file moved to this comment section ; MD file deleted**

Draft: Instructor Documentation Notes / Feedback / Potential Edits

General Notes & Feedback for Instructor Setup Documentation

  • Overall, extremely clear and detailed
    • I only have a few notes/feedback for small fixes (see sections listed below)

Specific Instructor Setup Documentation Potential Edits

COURSE EXTENSION REQUESTS SECTION:

  • IMPORTANT: The documentation prompts instructors to "Click View next to any request to access its full details." However, there is no "View" button next to any of the requests on the requests page. Instead, this should prompt instructors to click the student's name associated with the request that they would like to view the details of.
    • The same goes for the instructions for editing extension requests, as well as the instructions for Method 2 of accepting or denying requests
  • Another potential fix could be to actually add a View button for each request

VIEWING REQUEST HISTORY SECTION:

  • The documentation prompts instructors to "click the View all Requests button at the top left" of the page, but the button is actually at the top right of the page.

SYNCING ENROLLMENTS SECTION:

  • Important: The Enrollments tab doesn't appear to have a 'Sync Enrollments' button
    • Note that this could be due to the fact that the course I'm looking at for reference has already been synced and the time that I'm reviewing these details is after the semester has already ended (however, the instructions seem to imply that the button should still be there regardless, in order to handle any necessary future syncing)

AUTO-APPROVAL SETTINGS SECTION:

  • Refers to a section on the Settings page called "Auto-approve within days (Ex)," however, this section is actually called "Auto approve extended requests within days"
    • The documentation states that this section exists to apply limitations for students with DSP accommodations, but the actual page on Flextensions says that it is to be used for "students who have extenuating circumstances." I'm not sure which is correct or the most-up-to-date.
  • Change "Email Setting section" to "Email Settings tab" just to clarify that the instructor should be referring to the next tab on the Settings page.

coderNini added 2 commits June 4, 2026 01:16
File deleted and contents moved to comment section of corresponding Draft PR
Updated instructions for viewing and editing extension requests, including clarifications on viewing options and button placements.

Applied the notes in the Draft PR to the best of my abilities.
@cycomachead cycomachead marked this pull request as ready for review June 4, 2026 17:50
@yanlisa

yanlisa commented Jun 4, 2026

Copy link
Copy Markdown
  • Sync Enrollments: instructor button at present, should probably move to top

Comment thread docs/instructors.md Outdated
@cycomachead cycomachead changed the title Draft Instructor Documentation with Notes and Edits Instructor Documentation with Notes and Edits Jun 4, 2026
Comment thread docs/instructors.md Outdated
@cycomachead cycomachead merged commit 798a31d into main Jul 2, 2026
11 of 13 checks passed
@cycomachead cycomachead deleted the instructor-facing-documentation branch July 2, 2026 03:36
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.

3 participants