Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Open Beginner friendly
  • Is something wrong?
#1,789 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
typescript
Domain
documentation

Research direction

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.

Written by the indexing model from the issue text.

Description

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).

Dominant language
TypeScript
Stars
119
Forks
19
Avg merge
1d 2h
Merged PRs (30d)
56

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from DouglasNeuroInformatics/OpenDataCapture

All issues in DouglasNeuroInformatics/OpenDataCapture

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.