close
The Wayback Machine - https://web.archive.org/web/20210726081152/https://github.com/parcel-bundler/parcel/pull/3374
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

V2 README #3374

Merged
merged 6 commits into from Aug 13, 2019
Merged

V2 README #3374

merged 6 commits into from Aug 13, 2019

Conversation

@padmaia
Copy link
Contributor

@padmaia padmaia commented Aug 12, 2019

Notable Changes

  • Merged Parcel 2 RFC into main README
  • Pulled Getting Started from RFC and moved it to the top. Moved rest of RFC underneath Documentation and added a generated Table of Contents.
  • Added a script to lint that fails if the README's toc need to be updated and committed
  • Moved the README to the parcel package and linked it in the root of the repo

Test Plans

  • Updated README in a way that would change Table of Contents and verified script failed
  • Updated README in a way that would not change Table of Contents and verified script passed
@padmaia padmaia force-pushed the v2-readme branch 2 times, most recently from c63e7f7 to dad0f2a Aug 12, 2019
const {readFileSync} = require('fs');
const path = require('path');

const README_PATH = path.join(__dirname, '../README.md');

This comment has been minimized.

@kwelch

kwelch Aug 13, 2019
Contributor

In the script you passed the file path in, is the plan to expand this to allow for using that instead of the constant?

@kwelch
kwelch approved these changes Aug 13, 2019
Copy link
Contributor

@kwelch kwelch left a comment

👍 I like the idea of using the RFC.

@padmaia padmaia force-pushed the v2-readme branch from ff2910d to b01d6b6 Aug 13, 2019
@devongovett devongovett merged commit 7282927 into v2 Aug 13, 2019
10 checks passed
10 checks passed
@azure-pipelines
parcel-bundler.parcel Build #20190813.8 succeeded
Details
@azure-pipelines
parcel-bundler.parcel (Linux node_10_x) Linux node_10_x succeeded
Details
@azure-pipelines
parcel-bundler.parcel (Linux node_12_x) Linux node_12_x succeeded
Details
@azure-pipelines
parcel-bundler.parcel (Linux node_8_x) Linux node_8_x succeeded
Details
@azure-pipelines
parcel-bundler.parcel (Windows node_10_x) Windows node_10_x succeeded
Details
@azure-pipelines
parcel-bundler.parcel (Windows node_12_x) Windows node_12_x succeeded
Details
@azure-pipelines
parcel-bundler.parcel (Windows node_8_x) Windows node_8_x succeeded
Details
@azure-pipelines
parcel-bundler.parcel (macOS node_10_x) macOS node_10_x succeeded
Details
@azure-pipelines
parcel-bundler.parcel (macOS node_12_x) macOS node_12_x succeeded
Details
@azure-pipelines
parcel-bundler.parcel (macOS node_8_x) macOS node_8_x succeeded
Details
@devongovett devongovett deleted the v2-readme branch Aug 13, 2019
@@ -1286,38 +1341,73 @@ asset graph. They mostly call out to different compilers and preprocessors.
import {Transform} from '@parcel/plugin';

This comment has been minimized.

@kwelch

kwelch Aug 13, 2019
Contributor

This part of the docs seem to match up with the PR I created, #3075. Maybe what I wrote is not necessary and we can close that PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants