FredKSchott/snowpack

💡 RFC: Add example snowpack.config file to docs.

Open

Aperta il 5 lug 2021

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)JavaScript (19.541 star) (923 fork)batch import
contributors welcome!documentationgood first issue

Descrizione

Motivation

Currently in docs all of the config properties in the docs are presented without showing their containing parent nodes.

Proposed solution

It would be great to have complete example with full complete explicit default settings.

Detailed design

No response

Open questions

No response

Help make it happen!

  • I am willing to submit a PR to implement this change.
  • I am willing to submit a PR to implement this change, but would need some guidance.
  • I am not willing to submit a PR to implement this change.

Guida contributor

Tech stack
javascript
Dominio
documentationtooling
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
under 1 hour
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Basic JavaScriptFamiliarity with snowpack configuration
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85
Direzione di ricerca
Look at the existing documentation structure for configuration. Add a complete example snowpack.config.js file showing all default settings. The file should be placed in the docs directory, possibly alongside the config reference. Reference the existing config documentation for formatting.