Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moving Create-Snowpack-App to its own page, minor changes to Getting Started page #1494

Merged
merged 6 commits into from
Nov 3, 2020

Conversation

melissamcewen
Copy link
Contributor

Changes

  • Moves based create-snowpack-app docs/list to its own page
  • Creates a new quick-start section in Getting Started that aims to get anyone up and running immediately
  • Moves that quick start to the top
  • Removes migrating section, I think we should create a guide for that but open to suggestions

I think there are still a lot of issues with this page, maybe it should be in a more opinionated guide format that takes the user step by step?

Testing

No docs tests right now.

Docs

Is docs

@vercel
Copy link

vercel bot commented Nov 2, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/pikapkg/snowpack/78t0kwiw9
✅ Preview: https://snowpack-git-create-snowpack-app-docs.pikapkg.vercel.app

@melissamcewen
Copy link
Contributor Author

Discussed with Fred and we're gonna go the more guide-like directory showing how to install Snowpack from scratch

@melissamcewen
Copy link
Contributor Author

Thinking of getting rid of the CSA page and link to the github readme?

@melissamcewen
Copy link
Contributor Author

OK this removes the CSA section entirely, linking to the docs in GitHub instead. A new PR will address the revamp of the install guide.

@melissamcewen melissamcewen merged commit eb52644 into docs-refactor Nov 3, 2020
@melissamcewen melissamcewen deleted the create-snowpack-app-docs branch November 3, 2020 20:20
melissamcewen pushed a commit that referenced this pull request Nov 17, 2020
* React + Snowpack Guide (#1309)

* adding react guide

* fixing page title

* fixing a sentence

* copy edits

* copy edits

* Refactoring CSS/Diffing copy paste solution
Spinning the CSS into seperate files to make them easier to refactor, testing a solution for diffing copy/paste

* copy edits

* copy edits, restructuring

* adding some images

* image optmization, frame

* adding more images

* Update repository URL

* Incorporate guides.css

* Add more guides styling

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Fix indentation

* changing header image

* type in bash command

* fixing typo

* fixing typo

* fixing typo

* revising folder structure section

* adding video

* updating video

* adding back gif

* initial migration of docs to Snowpack

* removing boilerplate ref to canvas confetti

* changing output directory

* adding cssnano

* ugh accidental commit of output dir

* removing old original file

* removing includes files in guides since those will be added later, fixing Snowpack config

* fixing start command to process sass

* removing generated file, readding test

* edits

* re-adding cat behavior until we have seperate pages

* error in package.json

* fixing output directory

* changing order of build commands

* changing order of build commands

* copy edits

* twitter share

Co-authored-by: Drew Powers <drew@pow.rs>
Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* [WIP] Initial migration of docs to Snowpack (#1413)

* initial migration of docs to Snowpack

* removing boilerplate ref to canvas confetti

* changing output directory

* adding cssnano

* ugh accidental commit of output dir

* removing old original file

* removing includes files in guides since those will be added later, fixing Snowpack config

* fixing start command to process sass

* removing generated file, readding test

* re-adding cat behavior until we have seperate pages

* error in package.json

* fixing output directory

* changing order of build commands

* changing order of build commands

* removing JS out of template

* Docs split into multiple pages (#1437)

* initial migration of docs to Snowpack

* removing boilerplate ref to canvas confetti

* changing output directory

* adding cssnano

* ugh accidental commit of output dir

* removing old original file

* removing includes files in guides since those will be added later, fixing Snowpack config

* fixing start command to process sass

* removing generated file, readding test

* re-adding cat behavior until we have seperate pages

* error in package.json

* fixing output directory

* changing order of build commands

* changing order of build commands

* removing docs folder, moving to pages

* moving get started

* removing JS out of template

* removing refs to building md

* creating index page

* organizing files

* cleaning up files

* reorganizing based on 1430

* rearranging headings, removing comments

* adding menu items

* rearranging menu

* fixing back link

* removing top nav

* splitting up into guides

* adding home header

* readding subpage header

* adding titles to front matter

* trying to fix this bug

* removing redirect

* fixing issues from feedback

* removing overview from home page

* removing test for anchors since it's no longer a long page

* letting it pass with no tests

* removing build

* stub for docs readme

* removing JSX guide (#1490)

* Move plugin-related guide stubs to plugins (#1492)

* moving a couple of guides to plugins

* deleting svelte

* Moving Create-Snowpack-App to its own page, minor changes to Getting Started page (#1494)

* refactoring getting started, create-snowpack-app page

* fixing typo

* fixing typo

* fixing typo

* moving in menu

* deleting cra docs

* removing tailwind and postcss guide stubs (#1493)

* removing supported libraries stub

* removing eslint

* outline/draft of getting started

* copywriting

* deleting overview, copy edits and image descriptions

* copy edits

* Plugins refactor (#1582)

* merging in plugin page

* linking to getting started

* 1467

* #1457

* #1451

* #1445

* #1432

* 1457

* #1515

* fixing menu

* adding search index

* removing old file

* removing old file

* resolve issues

* merging in master

* add a sub-page navigation sidebar (#1586)

* splitting up deployment guide, copy edits

* fixing link

* style guide

* splitting up into pages (#1628)

Co-authored-by: Drew Powers <drew@pow.rs>
Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>
Co-authored-by: Fred K. Schott <fkschott@gmail.com>
FredKSchott added a commit that referenced this pull request Nov 17, 2020
* React + Snowpack Guide (#1309)

* adding react guide

* fixing page title

* fixing a sentence

* copy edits

* copy edits

* Refactoring CSS/Diffing copy paste solution
Spinning the CSS into seperate files to make them easier to refactor, testing a solution for diffing copy/paste

* copy edits

* copy edits, restructuring

* adding some images

* image optmization, frame

* adding more images

* Update repository URL

* Incorporate guides.css

* Add more guides styling

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Fix indentation

* changing header image

* type in bash command

* fixing typo

* fixing typo

* fixing typo

* revising folder structure section

* adding video

* updating video

* adding back gif

* initial migration of docs to Snowpack

* removing boilerplate ref to canvas confetti

* changing output directory

* adding cssnano

* ugh accidental commit of output dir

* removing old original file

* removing includes files in guides since those will be added later, fixing Snowpack config

* fixing start command to process sass

* removing generated file, readding test

* edits

* re-adding cat behavior until we have seperate pages

* error in package.json

* fixing output directory

* changing order of build commands

* changing order of build commands

* copy edits

* twitter share

Co-authored-by: Drew Powers <drew@pow.rs>
Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* [WIP] Initial migration of docs to Snowpack (#1413)

* initial migration of docs to Snowpack

* removing boilerplate ref to canvas confetti

* changing output directory

* adding cssnano

* ugh accidental commit of output dir

* removing old original file

* removing includes files in guides since those will be added later, fixing Snowpack config

* fixing start command to process sass

* removing generated file, readding test

* re-adding cat behavior until we have seperate pages

* error in package.json

* fixing output directory

* changing order of build commands

* changing order of build commands

* removing JS out of template

* Docs split into multiple pages (#1437)

* initial migration of docs to Snowpack

* removing boilerplate ref to canvas confetti

* changing output directory

* adding cssnano

* ugh accidental commit of output dir

* removing old original file

* removing includes files in guides since those will be added later, fixing Snowpack config

* fixing start command to process sass

* removing generated file, readding test

* re-adding cat behavior until we have seperate pages

* error in package.json

* fixing output directory

* changing order of build commands

* changing order of build commands

* removing docs folder, moving to pages

* moving get started

* removing JS out of template

* removing refs to building md

* creating index page

* organizing files

* cleaning up files

* reorganizing based on 1430

* rearranging headings, removing comments

* adding menu items

* rearranging menu

* fixing back link

* removing top nav

* splitting up into guides

* adding home header

* readding subpage header

* adding titles to front matter

* trying to fix this bug

* removing redirect

* fixing issues from feedback

* removing overview from home page

* removing test for anchors since it's no longer a long page

* letting it pass with no tests

* removing build

* stub for docs readme

* removing JSX guide (#1490)

* Move plugin-related guide stubs to plugins (#1492)

* moving a couple of guides to plugins

* deleting svelte

* Moving Create-Snowpack-App to its own page, minor changes to Getting Started page (#1494)

* refactoring getting started, create-snowpack-app page

* fixing typo

* fixing typo

* fixing typo

* moving in menu

* deleting cra docs

* removing tailwind and postcss guide stubs (#1493)

* removing supported libraries stub

* removing eslint

* outline/draft of getting started

* copywriting

* deleting overview, copy edits and image descriptions

* copy edits

* Plugins refactor (#1582)

* merging in plugin page

* linking to getting started

* 1467

* #1457

* #1451

* #1445

* #1432

* 1457

* #1515

* fixing menu

* adding search index

* removing old file

* removing old file

* resolve issues

* merging in master

* add a sub-page navigation sidebar (#1586)

* splitting up deployment guide, copy edits

* fixing link

* style guide

* splitting up into pages (#1628)

Co-authored-by: Drew Powers <drew@pow.rs>
Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>
Co-authored-by: Fred K. Schott <fkschott@gmail.com>
FredKSchott added a commit that referenced this pull request Nov 17, 2020
* React + Snowpack Guide (#1309)

* adding react guide

* fixing page title

* fixing a sentence

* copy edits

* copy edits

* Refactoring CSS/Diffing copy paste solution
Spinning the CSS into seperate files to make them easier to refactor, testing a solution for diffing copy/paste

* copy edits

* copy edits, restructuring

* adding some images

* image optmization, frame

* adding more images

* Update repository URL

* Incorporate guides.css

* Add more guides styling

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Update www/guides/react.md

Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* Fix indentation

* changing header image

* type in bash command

* fixing typo

* fixing typo

* fixing typo

* revising folder structure section

* adding video

* updating video

* adding back gif

* initial migration of docs to Snowpack

* removing boilerplate ref to canvas confetti

* changing output directory

* adding cssnano

* ugh accidental commit of output dir

* removing old original file

* removing includes files in guides since those will be added later, fixing Snowpack config

* fixing start command to process sass

* removing generated file, readding test

* edits

* re-adding cat behavior until we have seperate pages

* error in package.json

* fixing output directory

* changing order of build commands

* changing order of build commands

* copy edits

* twitter share

Co-authored-by: Drew Powers <drew@pow.rs>
Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>

* [WIP] Initial migration of docs to Snowpack (#1413)

* initial migration of docs to Snowpack

* removing boilerplate ref to canvas confetti

* changing output directory

* adding cssnano

* ugh accidental commit of output dir

* removing old original file

* removing includes files in guides since those will be added later, fixing Snowpack config

* fixing start command to process sass

* removing generated file, readding test

* re-adding cat behavior until we have seperate pages

* error in package.json

* fixing output directory

* changing order of build commands

* changing order of build commands

* removing JS out of template

* Docs split into multiple pages (#1437)

* initial migration of docs to Snowpack

* removing boilerplate ref to canvas confetti

* changing output directory

* adding cssnano

* ugh accidental commit of output dir

* removing old original file

* removing includes files in guides since those will be added later, fixing Snowpack config

* fixing start command to process sass

* removing generated file, readding test

* re-adding cat behavior until we have seperate pages

* error in package.json

* fixing output directory

* changing order of build commands

* changing order of build commands

* removing docs folder, moving to pages

* moving get started

* removing JS out of template

* removing refs to building md

* creating index page

* organizing files

* cleaning up files

* reorganizing based on 1430

* rearranging headings, removing comments

* adding menu items

* rearranging menu

* fixing back link

* removing top nav

* splitting up into guides

* adding home header

* readding subpage header

* adding titles to front matter

* trying to fix this bug

* removing redirect

* fixing issues from feedback

* removing overview from home page

* removing test for anchors since it's no longer a long page

* letting it pass with no tests

* removing build

* stub for docs readme

* removing JSX guide (#1490)

* Move plugin-related guide stubs to plugins (#1492)

* moving a couple of guides to plugins

* deleting svelte

* Moving Create-Snowpack-App to its own page, minor changes to Getting Started page (#1494)

* refactoring getting started, create-snowpack-app page

* fixing typo

* fixing typo

* fixing typo

* moving in menu

* deleting cra docs

* removing tailwind and postcss guide stubs (#1493)

* removing supported libraries stub

* removing eslint

* outline/draft of getting started

* copywriting

* deleting overview, copy edits and image descriptions

* copy edits

* Plugins refactor (#1582)

* merging in plugin page

* linking to getting started

* 1467

* #1457

* #1451

* #1445

* #1432

* 1457

* #1515

* fixing menu

* adding search index

* removing old file

* removing old file

* resolve issues

* merging in master

* add a sub-page navigation sidebar (#1586)

* splitting up deployment guide, copy edits

* fixing link

* style guide

* splitting up into pages (#1628)

Co-authored-by: Drew Powers <drew@pow.rs>
Co-authored-by: Drew Powers <1369770+drwpow@users.noreply.github.com>
Co-authored-by: Fred K. Schott <fkschott@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant