FredKSchott/snowpack

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

Open

#3,540 建立於 2021年7月5日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)JavaScript (19,541 star) (923 fork)batch import
contributors welcome!documentationgood first issue

描述

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.

貢獻者指南

技術棧
javascript
領域
documentationtooling
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic JavaScriptFamiliarity with snowpack configuration
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85
研究方向
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.
💡 RFC: Add example snowpack.config file to docs. · FredKSchott/snowpack#3540 | Good First Issue