FredKSchott/snowpack

đź’ˇ RFC: Add example snowpack.config file to docs.

Open

#3.540 geöffnet am 5. Juli 2021

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (19.541 Stars) (923 Forks)batch import
contributors welcome!documentationgood first issue

Beschreibung

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.

Contributor Guide

Tech Stack
javascript
Domain
documentationtooling
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic JavaScriptFamiliarity with snowpack configuration
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85
Research-Richtung
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.