chore: gitignore new-docs (#6511)

They are generating a lot of noise in PRs. This commit removes them from git, but updates CI to generate them - to ensure there are no errors when generating the new documentation. Further commits will: 1. Introduce linting to enforce methods are documented. 2. Generate previews of the new docs via GitHub actions or similar.
puppeteer · Oct 14, 2020 · 637a1f7 · 637a1f7
1 parent e655bb6
commit 637a1f7
Show file tree

Hide file tree

Showing 4,147 changed files with 3 additions and 66,549 deletions.
diff --git a/.gitignore b/.gitignore
@@ -18,3 +18,4 @@ test/coverage.json
 temp/
 dependency-chart.png
 puppeteer-core-*.tgz
+new-docs/
diff --git a/.travis.yml b/.travis.yml
@@ -71,7 +71,8 @@ jobs:
         - CHROMIUM=true
       script:
         - npm run lint
-        - npm run ensure-new-docs-up-to-date
+        # Ensure that we can generate the new docs without erroring
+        - npm run generate-docs
         - npm run ensure-correct-devtools-protocol-revision
 
     # This bot runs separately as it changes package.json to test puppeteer-core

diff --git a/new-docs/index.md b/new-docs/index.md
diff --git a/new-docs/puppeteer.accessibility.md b/new-docs/puppeteer.accessibility.md
diff --git a/new-docs/puppeteer.accessibility.snapshot.md b/new-docs/puppeteer.accessibility.snapshot.md
diff --git a/new-docs/puppeteer.boundingbox.height.md b/new-docs/puppeteer.boundingbox.height.md
diff --git a/new-docs/puppeteer.boundingbox.md b/new-docs/puppeteer.boundingbox.md
diff --git a/new-docs/puppeteer.boundingbox.width.md b/new-docs/puppeteer.boundingbox.width.md
diff --git a/new-docs/puppeteer.boundingbox.x.md b/new-docs/puppeteer.boundingbox.x.md
diff --git a/new-docs/puppeteer.boundingbox.y.md b/new-docs/puppeteer.boundingbox.y.md
diff --git a/new-docs/puppeteer.boxmodel.border.md b/new-docs/puppeteer.boxmodel.border.md
diff --git a/new-docs/puppeteer.boxmodel.content.md b/new-docs/puppeteer.boxmodel.content.md
diff --git a/new-docs/puppeteer.boxmodel.height.md b/new-docs/puppeteer.boxmodel.height.md
diff --git a/new-docs/puppeteer.boxmodel.margin.md b/new-docs/puppeteer.boxmodel.margin.md
diff --git a/new-docs/puppeteer.boxmodel.md b/new-docs/puppeteer.boxmodel.md
diff --git a/new-docs/puppeteer.boxmodel.padding.md b/new-docs/puppeteer.boxmodel.padding.md
diff --git a/new-docs/puppeteer.boxmodel.width.md b/new-docs/puppeteer.boxmodel.width.md
diff --git a/new-docs/puppeteer.browser.browsercontexts.md b/new-docs/puppeteer.browser.browsercontexts.md
diff --git a/new-docs/puppeteer.browser.close.md b/new-docs/puppeteer.browser.close.md
diff --git a/new-docs/puppeteer.browser.createincognitobrowsercontext.md b/new-docs/puppeteer.browser.createincognitobrowsercontext.md
diff --git a/new-docs/puppeteer.browser.defaultbrowsercontext.md b/new-docs/puppeteer.browser.defaultbrowsercontext.md