Skip to content
This repository has been archived by the owner on Jan 11, 2023. It is now read-only.

[Request] add README to autocopied runtime #879

Open
swyxio opened this issue Sep 9, 2019 · 4 comments
Open

[Request] add README to autocopied runtime #879

swyxio opened this issue Sep 9, 2019 · 4 comments

Comments

@swyxio
Copy link

swyxio commented Sep 9, 2019

Is your feature request related to a problem? Please describe.

as someone new to sapper, i get scared when i see a bunch of big files in src/node_modules/@sapper with no explanation apart from // This file is generated by Sapper — do not edit it! on some (not all! weirdly) files

Describe the solution you'd like

add a readme to explain what this is, what can be ignored, what files (if any) can be edited, link to more info, and any FAQs (in particular people are probably going to ask about the node_modules thing.. i know i know..)

as this serves as documentation-in-place, its a nicer option than hoping someone reads the right paragraph on the docs

Describe alternatives you've considered

do nothing

How important is this feature to you?

moderate importance to demystify sapper file structure for newbies like me

you could add it to this folder then add to the copied files here

@swyxio
Copy link
Author

swyxio commented Sep 14, 2019

@benmccann
Copy link
Member

@swyxio
Copy link
Author

swyxio commented Aug 28, 2020

sure. i'd still prefer if there were a readme that was shipped with it, but your call, and i wont mind if this is closed.

@benmccann
Copy link
Member

yeah, I think it's a good idea, which is why I left this open. It'd be easy enough to implement. The README could just point to the FAQ perhaps 🙂

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants