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

README on this repo should include build instructions #6

Closed
ghost opened this issue Feb 21, 2019 · 0 comments
Closed

README on this repo should include build instructions #6

ghost opened this issue Feb 21, 2019 · 0 comments
Assignees

Comments

@ghost
Copy link

ghost commented Feb 21, 2019

When I copied this repo over from ipfs/docs, I blanked out the README.md file to reduce confusion over what this repo was for. However, there is some content in the original README.md that we actually probably want to bring back:

  • Building the docs site locally - this could come over verbatim
  • Explain that merged PRs kick off a rebuild+redeploy of docs.libp2p.io
  • Something about how to contribute to docs - this could be a pointer to an article on docs.libp2p.io itself, rather than repeating information in the readme. But people will expect to find something about how to contribute.

Not urgent, but just wanted to log this somewhere.

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

No branches or pull requests

1 participant