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

Architecture and Web reference pages describe packages and folders that no longer exist

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

Direzione di ricerca

Leggi .agents/docs/workspace-map.md e confrontalo con docs/en/4-concepts/4.0-architecture.mdx e docs/en/5-reference/5.4-web.mdx. Controlla le strutture attuali di packages/, apps/web/src/, apps/api/prisma/ e apps/gateway/prisma/; formatta l’albero Web all’interno di <FileTree> con una voce di elenco Markdown per riga. Compila la documentazione e verifica che la pagina Web renderizzata mostri una riga separata per ogni voce.

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

Descrizione

Area: Outreach Bug Difficulty: Low Priority: Low

The Architecture concept page and the Web reference page describe a codebase that no longer exists, and the Web page's file tree does not render as a tree.

  • Architecture. The page lists 22 packages. Eleven of them are not in packages/: crypto, esbuild-plugin-runtime, i18next, instrument-renderer, instrument-runtime-env, json-utils, prisma-client, runtime-resolve, stats, tailwindcss and vite-plugin-plausible. It also lists testing/k6, which does not exist. It omits runtime-core, runtime-bundler, runtime-internal, runtime-meta, serve-instrument, instrument-guidelines, playground-url, release-info, and the top-level vendor/, storybook/ and cli/. Its Databases section says both Prisma schemas are "stored in the packages/prisma-client folder"; they are apps/api/prisma/schema.prisma and apps/gateway/prisma/schema.prisma.
  • Web. The page describes features/, typings/, Router.tsx and a config.ts-plus-Router.tsx routing setup. The app now routes with TanStack Router from src/routes/ and the generated src/route-tree.ts, and has providers/ and utils/, none of which the page mentions. The <FileTree> content has been reflowed into one paragraph, so Starlight renders a single collapsed src/ entry. Every other line appears as one long grey "comment" beside it.

A contributor using these pages to find their way around the repository is sent to directories that are not there.

Where

docs/en/4-concepts/4.0-architecture.mdx:26-53 (excerpt) and :79-82:

- packages/
  - crypto/
  - demo/
  - esbuild-plugin-runtime/
  - i18next/
  ...
- testing/
  - k6/
...
In both cases, schemas are defined using [Prisma](https://www.prisma.io/) and stored in the `packages/prisma-client`
folder.

docs/en/5-reference/5.4-web.mdx:15-20:

<FileTree>
  - src/ - assets contains static files (e.g., images, fonts) - components common reusable components - features
  contains code specific to a feature - hooks shared hooks - services re-exporting preconfigured libraries - store
  global state stores managed with zustand - testing - translations - typings - App.tsx the top-level element of the
  application - Router.tsx the routing configuration - config.ts - main.tsx the entry point to the application
</FileTree>

Built output, dist/en/docs/reference/web/index.html:

<li class="directory"><details><summary>…src/</span> <span class="comment">- assets contains static files (e.g., images, fonts) - components common reusable components - features …</span>

Reproduce

  1. Open https://opendatacapture.org/en/docs/concepts/architecture/ and compare the tree with ls packages testing.
  2. Open https://opendatacapture.org/en/docs/reference/web/ and look at the "Directory Structure" tree.

Actual: eleven listed packages and testing/k6 do not exist, eight current packages are missing, and the Prisma schema location is wrong. The Web tree is one src/ row with the entire listing as its comment.
Expected: both trees match packages/ and apps/web/src/ as they are today, and the Web tree renders one row per entry.

Tests

docs/ has no test runner (docs/AGENTS.md). The build is the check: dist/en/docs/reference/web/index.html renders one <li> per entry, with none of the listing inside a class="comment" span.

Suggested fix

Regenerate both trees from the current layout; .agents/docs/workspace-map.md already describes every workspace. In 5.4-web.mdx, write the tree as a Markdown list with one entry per line, starting at column 0 inside <FileTree>, the way 4.0-architecture.mdx does. That page's tree survived formatting, while the indented one here was reflowed into a paragraph. Point the Databases section at apps/api/prisma and apps/gateway/prisma.

Lingua principale
TypeScript
Stelle
119
Fork
19
Merge medio
3g 23h
PR unite (30g)
38

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.