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

Documentation website #163

Open
conartist6 opened this issue Jan 27, 2019 · 3 comments
Open

Documentation website #163

conartist6 opened this issue Jan 27, 2019 · 3 comments

Comments

@conartist6
Copy link
Member

Let's make a doc website for iter-tools.

I think we're to the point where it would be beneficial to have the npm readme to extoll the virtues of iter-tools. We should be telling people why they want to use it, and if we convince them then they can move on to an even more pleasant way of interacting with our documentation.

@sithmel
Copy link
Collaborator

sithmel commented Jan 27, 2019

Definitely!
As soon as I manage to clean up a few pending issues/PRs, I'd like to create a new ticket where we collaboratively set the goal for the new major release.

This should be one of them.

@KSXGitHub
Copy link
Collaborator

We should also add jsdoc comments to the code, it would help IntelliSense user, it can be used to generate web pages.

@conartist6
Copy link
Member Author

A website is sneaking higher and higher on my list of priorities. As you suggest @KSXGitHub I do think I'll move from central API docs in the README to jsdoc style comments at the top of a method's source which will be parsed by the website generator.

@conartist6 conartist6 pinned this issue Nov 11, 2019
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

3 participants