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

docs(v2): Add READMEs to v2 packages #4034

Merged
merged 4 commits into from
Jan 14, 2021
Merged

docs(v2): Add READMEs to v2 packages #4034

merged 4 commits into from
Jan 14, 2021

Conversation

RDIL
Copy link
Contributor

@RDIL RDIL commented Jan 12, 2021

Signed-off-by: Reece Dunham me@rdil.rocks

Motivation

Adds basic readmes to each of the v2 packages that don't have one.

I didn't put that much content in them, just relevant docs links, because I don't have hours to spare writing all this.

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

n/a

Related PRs

n/a

Signed-off-by: Reece Dunham <me@rdil.rocks>
@netlify
Copy link

netlify bot commented Jan 12, 2021

❌ [V1] Deploy preview failure

🔨 Explore the source changes: 6f7b1e0

🔍 Inspect the deploy logs: https://app.netlify.com/sites/docusaurus-1/deploys/600068f4d8e80800081fc18b

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jan 12, 2021
@github-actions
Copy link

github-actions bot commented Jan 12, 2021

Size Change: 0 B

Total Size: 26.8 kB

ℹ️ View Unchanged
Filename Size Change
website/build/blog/2017/12/14/introducing-docusaurus/index.html 20.8 kB 0 B
website/build/docs/introduction/index.html 180 B 0 B
website/build/index.html 5.86 kB 0 B

compressed-size-action

@netlify
Copy link

netlify bot commented Jan 12, 2021

✔️ Deploy preview for docusaurus-2 ready!
Built without sensitive environment variables

🔨 Explore the source changes: c25b4e1

🔍 Inspect the deploy logs: https://app.netlify.com/sites/docusaurus-2/deploys/5ffdd9b83dd12500089d32d2

😎 Browse the preview: https://deploy-preview-4034--docusaurus-2.netlify.app

@github-actions
Copy link

github-actions bot commented Jan 12, 2021

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟢 Performance 95
🟢 Accessibility 99
🟢 Best practices 100
🟢 SEO 100
🟢 PWA 95

Lighthouse ran on https://deploy-preview-4034--docusaurus-2.netlify.app/classic/

@netlify
Copy link

netlify bot commented Jan 12, 2021

✔️ Deploy preview for docusaurus-2 ready!

🔨 Explore the source changes: 6f7b1e0

🔍 Inspect the deploy logs: https://app.netlify.com/sites/docusaurus-2/deploys/600068f4aad51f00087ca12d

😎 Browse the preview: https://deploy-preview-4034--docusaurus-2.netlify.app

packages/docusaurus-plugin-sitemap/README.md Outdated Show resolved Hide resolved
packages/docusaurus/README.md Outdated Show resolved Hide resolved
@slorber
Copy link
Collaborator

slorber commented Jan 14, 2021

Thanks, LGTM 👍

Removed the Docusaurus readme content as it's mostly v1 links there and we can't simply copy the home readme.

We'll rewrite the home readme very soon anyway

@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Jan 14, 2021
@slorber slorber merged commit 0252d01 into facebook:master Jan 14, 2021
@RDIL RDIL deleted the readme-docs branch January 14, 2021 16:21
@lex111 lex111 added this to the v2.0.0-alpha.71 milestone Mar 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants