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.

Sign up for GitHub

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

Jump to bottom

Link to RTD documentation from README #915

Closed
boolean5 opened this issue May 4, 2021 · 2 comments
Closed

Link to RTD documentation from README #915

boolean5 opened this issue May 4, 2021 · 2 comments
Assignees
@Ayushsunny
Labels
documentation good-first-bug Bugs that are good for a first-time committer to tackle

Comments

@boolean5
Copy link
Contributor

boolean5 commented May 4, 2021

In order to make our new documentation on readthedocs discoverable, we should add its link (https://openwpm.readthedocs.io) to the README and perhaps also embed a docs badge, by adding the following:

[![Documentation Status](https://readthedocs.org/projects/openwpm/badge/?version=latest)](https://openwpm.readthedocs.io/en/latest/?badge=latest)

Additionally, we could add the openwpm.readthedocs.io link to the About section of the repository.
@boolean5 boolean5 added documentation good-first-bug Bugs that are good for a first-time committer to tackle labels May 4, 2021
@vringar vringar mentioned this issue May 7, 2021
Open
@vringar
Copy link
Contributor

vringar commented May 10, 2021

@Ayushsunny do you want to do this next?

@Ayushsunny
Copy link
Contributor

Yes @vringar, I wanna work on this.

@Ayushsunny Ayushsunny mentioned this issue May 12, 2021
Merged
@vringar vringar closed this as completed May 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Ayushsunny Ayushsunny

Labels
documentation good-first-bug Bugs that are good for a first-time committer to tackle
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@boolean5 @vringar @Ayushsunny