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

Adding MinkPhantomJSDriver to the documentation #71

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jcalderonzumba
Copy link

@jcalderonzumba jcalderonzumba commented Nov 23, 2016

Adding MinkPhantomJSDriver to the documentation via new section.
Driver is already integrated with mink/driver-test-suite and has been change to address all the topics discussed with @stof.

@@ -0,0 +1,85 @@
PhantomJSDriver
Copy link
Member

@stof stof Nov 23, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should be maintaining the doc for third-party drivers ourselves. You are the one knowing the driver and so you should be maintaining its doc.
The list of third-party drivers should have external links to your doc instead.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have a good point here, i'll create a phantomjsdriver.readthedocs.org page with the Driver info and link it here then.
I already have a gastonjs.readthedocs.org documentation so it makes senses to have a similar doc site for phantomjsdriver.
I'll update the PR once the new doc page is up and running.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if it is small, you could also use github itself to host the documentation (write it in markdown in this case though, as their rST renderer is not as good as their markdown one) (putting the doc in the /docs folder of the repo for instance)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, for the moment is small and mostly everything that i have written in this PR is contained in the README.md of the repo.

.. toctree::
:maxdepth: 1

/third-party-drivers/phantomjs.rst
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO, the third-party drivers could be a section at the end of the drivers page instead of a separate page containing only the list, which has a single element for now.
This could be changed in the future if we have tens of third-party drivers, but I doubt it will be the case.

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

Successfully merging this pull request may close these issues.

2 participants