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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add README to v1 #1031

Merged
merged 1 commit into from Oct 14, 2018

Conversation

Projects
None yet
3 participants
@yangshun
Member

yangshun commented Oct 13, 2018

Motivation

After moving v1 source into a v1 folder, the README is no longer showing on our npmjs package page - https://www.npmjs.com/package/docusaurus because the README remained in the root of the folder.

I copied the parts where I felt was relevant into the v1's README - basically stuff that's less engineering related and more about how to contact us, so that they can come to the main repo.

Suggestions welcome.

Have you read the Contributing Guidelines on pull requests?

馃

Test Plan

NA

@docusaurus-bot

This comment has been minimized.

Collaborator

docusaurus-bot commented Oct 13, 2018

Deploy preview for docusaurus-preview ready!

Built with commit 704beaa

https://deploy-preview-1031--docusaurus-preview.netlify.com

@yangshun yangshun merged commit 101a1a7 into master Oct 14, 2018

4 of 5 checks passed

ci/circleci: deploy/hold Your job is on hold on CircleCI!
Details
ci/circleci: prettier Your tests passed on CircleCI!
Details
ci/circleci: v1-tests Your tests passed on CircleCI!
Details
ci/circleci: v2-tests Your tests passed on CircleCI!
Details
deploy/netlify Deploy preview ready!
Details

@yangshun yangshun deleted the readme branch Oct 14, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment