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

Unify docs with webtorrent-www #507

Closed
feross opened this issue Dec 2, 2015 · 5 comments
Closed

Unify docs with webtorrent-www #507

feross opened this issue Dec 2, 2015 · 5 comments

Comments

@feross
Copy link
Member

@feross feross commented Dec 2, 2015

The WebTorrent API docs live in two places right now:

  1. README.md in this repo
  2. server/views/docs.jade in webtorrent-www

Let's unify these so we don't need to keep them manually in sync.

Also, move examples from examples/ to the website.

@DiegoRBaquero

This comment has been minimized.

Copy link
Member

@DiegoRBaquero DiegoRBaquero commented Dec 3, 2015

There's no way to embed external .md in markdown (in GitHub. What we can do is load the README.md, remove the non-api parts and present it in the website.

@feross feross added the help wanted label Feb 13, 2016
@rom1504

This comment has been minimized.

Copy link
Member

@rom1504 rom1504 commented Mar 16, 2016

What might be possible is the opposite: include webtorrent README.md (or a API.md subset extracted from it) into the jade file, since it's possible to include markdown in jade http://jade-lang.com/reference/includes/

edit: I guess including the whole README.md might be ok

@feross

This comment has been minimized.

Copy link
Member Author

@feross feross commented Mar 16, 2016

I'm working on fixing this right now.

feross added a commit that referenced this issue Mar 16, 2016
Merge the webtorrent-www API docs (for #507)
feross added a commit to webtorrent/webtorrent.io that referenced this issue Mar 16, 2016
@feross

This comment has been minimized.

Copy link
Member Author

@feross feross commented Mar 16, 2016

This is done! Docs now live in docs/.

@feross feross closed this Mar 16, 2016
@lock

This comment has been minimized.

Copy link

@lock lock bot commented May 4, 2018

This thread has been automatically locked because it has not had recent activity. To discuss futher, please open a new issue.

@lock lock bot locked as resolved and limited conversation to collaborators May 4, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.