nuxt / nuxt/module-builder

Conflict between folder structure in readme (src/runtime) and TypeScript config (src/module/runtime)

Open
#749 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
275
Forks
35
Avg merge
4h 42m
Merged PRs (30d)
6

Description

In the readme it says that runtime stuff should be in src/runtime, but the TypeScript config e.g. for the server env includes src/module/runtime. Intended?

Contributor guide

Open the contributing guide

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.

Research direction

Compare the README's src/runtime guidance with the TypeScript configuration entry for the server environment, especially its src/module/runtime path. Determine which folder structure is intended, then align the documentation or configuration so they agree and verify that the published guidance and server-environment setup are consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
build-system, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.