FredKSchott/snowpack

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

Open

#3,540 opened on Jul 5, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (923 forks)batch import
contributors welcome!documentationgood first issue

Repository metrics

Stars
 (19,541 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

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

Research direction
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.
Tech stack
javascript
Domain
documentationtooling
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Basic JavaScriptFamiliarity with snowpack configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85