Skip to content

docs(challenge-06): add missing Create pull request step on the compare page#247

Merged
accesswatch merged 1 commit into
mainfrom
fix/challenge6-create-pr-button
Jul 5, 2026
Merged

docs(challenge-06): add missing Create pull request step on the compare page#247
accesswatch merged 1 commit into
mainfrom
fix/challenge6-create-pr-button

Conversation

@accesswatch

Copy link
Copy Markdown
Collaborator

Fixes the instruction gap behind Community-Access/support#60.

Challenge 6 told learners to set base and compare and then write a PR title, but the title and description form only appears after activating the Create pull request button on the compare page. A screen reader user reading the long comparison preview had no way to discover that step.

Changes:

  • learning-room/.github/ISSUE_TEMPLATE/challenge-06-first-pr.yml: insert the Create pull request button step with screen reader navigation hints (button quick key, page search), note that the long preview is normal, clarify the second Create pull request button submits, and add a stuck-table row for "diff appears but no title or description field".
  • docs/06-working-with-pull-requests.md: the screen reader tool card for opening a PR from a branch stopped at choosing branches; add the Create pull request activation step (the visual card already had it).
  • work.md, html/: regenerated.

Validation: npm run build:html and npm run validate:authoritative-sources both pass.

Follow-up (not in this PR): sync the template change to learning-room-template and the cohort rooms.

🤖 Generated with Claude Code

…re page

A learner following Challenge 6 reached the compare view and found no
title or description form because the instructions jump from choosing
base and compare straight to writing a title (support#60). Add the
intermediate Create pull request button step with screen reader
navigation hints, explain why the comparison preview reads long, and
add a matching row to the stuck table and the chapter's screen reader
tool card.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@accesswatch
accesswatch requested a review from taylorarndt as a code owner July 5, 2026 02:45
Copilot AI review requested due to automatic review settings July 5, 2026 02:45
@github-actions

github-actions Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Learning Room Validation Report

Great work. Your changes look good.

Resources

@accesswatch
accesswatch merged commit 444fbe0 into main Jul 5, 2026
11 checks passed
@accesswatch
accesswatch deleted the fix/challenge6-create-pr-button branch July 5, 2026 02:45
@github-actions

github-actions Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Hi! I am Gandalf, your workshop agent. I bring a little magic to make this interaction clear, helpful, and fun. Here is my review of your pull request:

Report Status

Validation Needs Attention [ACTION REQUIRED]

Required Checks

  • Issue Reference
    PR should reference the issue it addresses (e.g., "Closes #12")
    Add "Closes #XX" to your PR description to automatically close the issue when merged. Learn more: docs/04-working-with-issues.md

  • PR Description

  • File Location
    Changes should be in learning-room/ directory only
    Student contributions should modify files in learning-room/docs/ only. Other directories are workshop infrastructure.

Learning Resources

Based on your changes, these guides might help:


Automated validation by Learning Room Bot. Gandalf generated this review. Last updated: 2026-07-05T02:45:26.850Z
Questions? Check PR Guidelines or mention @Facilitator

@github-actions github-actions Bot added documentation Improvements or additions to documentation needs-work labels Jul 5, 2026
@github-actions

github-actions Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Progress Update

Great work, @accesswatch!

Current Level: Explorer
Merged PRs: 29
Next Level: Contributor (NaN more merged PRs)

Available Challenges:

  • 01 Scavenger Hunt
  • 02 First Issue
  • 03 Join Conversation

Keep going!

@github-actions

github-actions Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Peer Review Assigned

Hi @accesswatch! Your PR has been automatically paired with @taylorarndt for peer review.

For @taylorarndt:

This is a great opportunity to practice code review skills! Here's what to look for:

Content Quality:

  • Does the change accomplish what the issue describes?
  • Is the writing clear and helpful?
  • Are there any typos or grammar issues?

Accessibility:

  • Proper heading hierarchy (H1 → H2 → H3, no skips)?
  • Descriptive link text (not "click here")?
  • Alt text on images?
  • [TODO] markers removed?

Documentation:

  • Code blocks are properly formatted?
  • Tables have headers?
  • References/links work correctly?

Review Guidelines:

  • Be kind and constructive
  • Suggest improvements, don't just point out problems
  • Ask questions if something is unclear
  • Approve when ready or request changes with explanation

Resources:


Pairing by Learning Room Grouping Engine

Copilot AI left a comment

Copy link
Copy Markdown

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 closes an instruction gap in Challenge 6 and Chapter 6 documentation by explicitly telling learners to activate the Create pull request button on the compare page before expecting the PR title/description form to appear, with added navigation hints for screen reader users.

Changes:

  • Adds a missing “Activate Create pull request” step (and “long preview is normal” context) to Challenge 6 learner instructions and the issue template.
  • Updates Chapter 6 screen reader instructions to include the missing activation step when opening a PR from a branch.
  • Regenerates committed HTML outputs (including search index) to reflect the Markdown/template updates.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
work.md Adds the missing “Create pull request” activation step and a new stuck-case row for missing PR form fields.
learning-room/.github/ISSUE_TEMPLATE/challenge-06-first-pr.yml Updates the Challenge 6 issue form instructions to include the missing compare-page button step and troubleshooting row.
docs/06-working-with-pull-requests.md Adds the missing compare-page “Create pull request” activation step for NVDA/JAWS screen reader instructions.
html/work.html Regenerated HTML for work.md to include the updated Challenge 6 steps and troubleshooting row.
html/search-index.json Regenerated search index to reflect updated documentation content.
html/docs/06-working-with-pull-requests.html Regenerated HTML for Chapter 6 to include the updated NVDA/JAWS instruction step.

2. A "Compare & pull request" banner may appear (if you recently pushed) - activate it
3. OR: Navigate to Pull Requests tab → "New pull request"
4. Choose your base branch (what to merge into) and compare branch (your changes)
5. Activate the **Create pull request** button. It sits between the branch choosers and the diff, and the title and description form appears only after you activate it. Use the button quick navigation key (B in NVDA and JAWS browse mode) or search the page for "Create pull request". The comparison preview can read as very long because it includes unchanged context lines - the form is above it, not below it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation needs-work

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants