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

How to Upload Data guide opens with the Visualize Data text, and two .md pages render a raw <steps> element

Aperta Adatta ai principianti
  • Qualcosa non va?
#1,789 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
78/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
typescript
Ambito
documentation

Direzione di ricerca

Read docs/en/3-guides/3.3-how-to-upload-data.md, docs/en/2-tutorials/2.3-simulate-poor-network.md, and the referenced 3.4-how-to-get-started-with-odc.mdx for the Starlight Steps pattern. Check upload visibility and permissions in apps/web/src/hooks/useNavItems.ts:90-100, then build with pnpm --filter @opendatacapture/outreach build. Done when both pages render class="sl-steps" without a raw <steps> element and the upload guide describes the correct flow.

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

Descrizione

Area: Outreach Bug Difficulty: Low Good First Issue Priority: Low

The "How to Upload Data" guide opens with text copied from the Visualize Data guide, and two Markdown pages render a raw <steps> element in place of Starlight's Steps component. The upload guide's first sentence reads "Open Data Capture allows you to visualize numeric measures over time in a single subject". Step 1 says you need permissions "to visualize subject data". Step 2 tells you to pick the group "you were using when you collected the data for this subject". None of this describes uploading a CSV. Separately, 3.3-how-to-upload-data.md and 2.3-simulate-poor-network.md are .md files that use <Steps>. Only MDX can import and render components, so Astro passes the tag through as an unknown HTML element, <steps><ol>…. The pages lose the numbered step styling that every other step-by-step page has.

Where

docs/en/3-guides/3.3-how-to-upload-data.md:8-22:

Open Data Capture allows you to visualize numeric measures over time in a single subject. These measures must be defined in the instrument.

### Steps

<Steps>

1.  **Login to Open Data Capture**

    First, login to your instance of Open Data Capture. In order to visualize subject data, you must have adequate permissions. ...

2.  **Select Your Group**

    Next, select the group that you were using when you collected the data for this subject
    (or were using to send the subject a remote assignment). ...

docs/en/2-tutorials/2.3-simulate-poor-network.md:29:

<Steps>

Both files have no import { Steps } from '@astrojs/starlight/components';, and as .md files they could not use one.

Reproduce

  1. Open https://opendatacapture.org/en/docs/guides/how-to-upload-data/.
  2. Inspect the list under "Steps", then do the same on https://opendatacapture.org/en/docs/tutorials/simulate-poor-network/.

Actual: the upload guide's introduction and first two steps describe visualizing data. Both pages wrap their lists in a literal <steps> element, rendered as a plain ordered list.
Expected: the upload guide's introduction describes CSV upload and the permissions it needs, and both pages render Starlight's Steps component like how-to-create-an-instrument.

Tests

docs/ has no test runner (docs/AGENTS.md). The build is the check: after pnpm --filter @opendatacapture/outreach build, neither page's HTML contains <steps>, and both contain class="sl-steps".

Suggested fix

Rename both files to .mdx (keeping their slug) and add import { Steps } from '@astrojs/starlight/components';, as 3.4-how-to-get-started-with-odc.mdx does. MDX rejects the unclosed <br> tags at lines 81, 93 and 96 of the upload guide, so change them to <br />. Then rewrite the upload guide's introduction and steps 1–2 to describe the Upload page. Upload is shown when the admin has enabled experimental features and the user can read Subject and create InstrumentRecord (apps/web/src/hooks/useNavItems.ts:90-100).

Lingua principale
TypeScript
Stelle
119
Fork
19
Merge medio
1g 2h
PR unite (30g)
56

Preparare l'ambiente

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 DouglasNeuroInformatics/OpenDataCapture

Tutte le issue di DouglasNeuroInformatics/OpenDataCapture

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.