Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[curriculum-eval] side-quest-01-02-environment-reference.md: cognitive_load — 1433-word reference page repeats every tool description twice

Chiusa Adatta ai principianti
  • Qualcosa non va?
#3,852 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
88/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
markdown
Ambito
documentation

Direzione di ricerca

Modifica workshop/side-quest-01-02-environment-reference.md, iniziando dalla tabella del glossario e dalla sezione “Conceptual screenshots”. Rimuovi solo le frasi esplicative che duplicano la tabella, mantenendo le immagini, il glossario e la checklist del checkpoint. Esegui npx --yes markdownlint-cli2 "**/*.md"; al termine, la pagina sarà più vicina alle 800–1000 parole e il lint passerà.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

curriculum documentation quality

File: workshop/side-quest-01-02-environment-reference.md
Overall Score: 4.93 / 10.0 (corpus mean: 6.09)

Flagged Dimensions:

Dimension Score Benchmark Delta
cognitive_load 6.3 ≤ 800 words −3.7 (1433 words, 633 over ideal)
active_learning 2.1 density ≥ 3 −7.9 (density 0.63)
readability (fk_grade) 10.0 grade 8–12 0 (10.7, within range — not a real problem)

Note: checkpoint_quality is reported as 0.0/has_checkpoint: false due to a confirmed tooling regex bug (see companion issue on curriculum_assessment.py) — this file has a ## :white_check_mark: Checkpoint section with 7 items. Excluded from this finding.

Root Cause (≤ 2 sentences):
This reference page is nearly double the ideal word budget (1433 vs. 800 words) because it repeats every tool twice — once in the glossary table and again in a full "Conceptual screenshots" section with its own paragraph per tool — and the ten image call-outs contribute almost no code blocks or checklist items, so activity density stays very low for a long page.

Evidence (quoted from the file):

| GitHub Codespaces | Your cloud development environment when you choose the browser-based setup path... |

GitHub Codespaces

(picture)...<img alt="Conceptual screenshot of GitHub Codespaces..." .../>(/picture)
You use Codespaces when you want a ready-to-go development environment in your browser.

Nine of the ten glossary rows are followed by an almost identical one-sentence restatement under the "Conceptual screenshots" heading, doubling word count without adding new information.

Learning Science Rationale:
Mayer's redundancy principle states that presenting the same explanation in text twice (once in a table, once in prose beside an image) does not aid learning and instead adds unnecessary reading load, since the image plus a single caption already conveys the "when you use it" information the table row states. As an optional reference page this is lower-stakes than a core lesson, but trimming the duplicated prose would let learners scan the page faster, which matters for its intended "look something up quickly" use case.

Improvement Prompt (for an agent):

Edit workshop/side-quest-01-02-environment-reference.md to remove redundant text and shorten the page toward 800-1000 words:

1. For each tool in the "Conceptual screenshots" section, replace the standalone explanatory sentence (e.g., "You use Codespaces when you want a ready-to-go development environment in your browser.") with a single-line image caption only if it adds information not already in the glossary table's "What it means" / "When you use it" columns. If the sentence merely restates the table row, delete it and rely on the table plus the image alt text.
2. Keep the glossary table as the single source of truth for definitions; keep the screenshots section focused only on visual recognition ("this is what X looks like"), not re-explaining what each tool does.
3. Do not remove the images, the glossary table, or the ## :white_check_mark: Checkpoint checklist — only trim duplicated prose.
4. Re-run npx --yes markdownlint-cli2 "**/*.md" after editing.

Expected Score After Fix: 6.6 / 10.0

Generated by 🔬 Curriculum Quality Evaluator · copilot · auto · 84.8 AIC · ⌖ 7.78 AIC · ⊞ 9K · ◷

  • expires on Sep 27, 2026, 8:49 AM UTC
Lingua principale
JavaScript
Stelle
49
Fork
20
Merge medio
9h 44m
PR unite (30g)
25

Preparare l'ambiente

Non abbiamo ancora controllato i file di configurazione di questo progetto. Parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di githubnext/gh-aw-workshop

Tutte le issue di githubnext/gh-aw-workshop

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.