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

Move the documentation from the wiki into pldoc #18

Open
shonfeder opened this issue May 4, 2019 · 3 comments
Open

Move the documentation from the wiki into pldoc #18

shonfeder opened this issue May 4, 2019 · 3 comments

Comments

@shonfeder
Copy link
Owner

shonfeder commented May 4, 2019

Currently, the most detailed documentation lives this repo's wiki. We should probably move this in to the pldoc instead, so it will be available in the package's documentation.

@shonfeder shonfeder changed the title Move the documentation in the wiki into pldoc screens Move the documentation from the wiki into pldoc May 4, 2019
@Anniepoo
Copy link
Collaborator

Anniepoo commented May 4, 2019

I just did the inverse with pack(identity).

I had all the docs in the readme. In particular, I had an ambitious 'roadmap'.
It complicated making branches to work on features, because the docs kept getting updated.

@shonfeder
Copy link
Owner Author

Isn't updating docs and merging in those changes just part of the development process? :) I'm a pretty big believer in keeping the documentation as close to the code as possible, since it makes it easier to keep things synced.

@Anniepoo
Copy link
Collaborator

Anniepoo commented May 4, 2019

Good argument. you're the boss here.

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

No branches or pull requests

2 participants