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

[PRC] Reorganize navigation of documentation #187

Closed
wants to merge 4 commits into
base: master
from

Conversation

Projects
None yet
3 participants
@JJ
Contributor

JJ commented Apr 26, 2017

Also adds cpanfile for easier local installation. I have navigated the documentation, noticed a possibly unneeded file (see #186 ) and reorganized pointers, as well as fixed a typo in this possibly unnecessary file.
I can go ahead and try and test-drive the documentation as pointed out in #185 . I do use external dependencies for some of my modules. I will create a separate PR.

@plicease

This comment has been minimized.

Show comment
Hide comment
@plicease

plicease Jun 5, 2017

Member

Merged, except for the cpanfile. For now I don't want to maintain the prereqs in two files, but we may add a cpanfile later.

Member

plicease commented Jun 5, 2017

Merged, except for the cpanfile. For now I don't want to maintain the prereqs in two files, but we may add a cpanfile later.

@plicease plicease closed this Jun 5, 2017

@jberger

This comment has been minimized.

Show comment
Hide comment
@jberger

jberger Jun 5, 2017

Member

I'm a big fan of cpanfile, but I agree with @plicease, we shouldn't have two copies of the prereqs to manage. A great part of cpanfile is that it makes for literate (in this case declarative) programming. But allowing for skew by only using it as documentation would be more of a detriment than a benefit.

Member

jberger commented Jun 5, 2017

I'm a big fan of cpanfile, but I agree with @plicease, we shouldn't have two copies of the prereqs to manage. A great part of cpanfile is that it makes for literate (in this case declarative) programming. But allowing for skew by only using it as documentation would be more of a detriment than a benefit.

@JJ

This comment has been minimized.

Show comment
Hide comment
@JJ

JJ Jun 5, 2017

Contributor

Maybe, as an alternative, move it to another directory? Thanks anyway for accepting the PR :-)

Contributor

JJ commented Jun 5, 2017

Maybe, as an alternative, move it to another directory? Thanks anyway for accepting the PR :-)

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