Documentation Needed

[PrabhanshuAttri]

http://pythonhosted.org/PyBeacon This task is easy. Create a directory named "build/docs" and add an HTML page with usage and a small description.

Reference

[raarts]

Returns 404 Not Found.

[vijayant123]

https://pypi.python.org/pypi/PyBeacon

Working link.

[raarts]

Yep. Thanks

[PrabhanshuAttri]

This is link is for documentation purpose. We are working on the documentation

[ravaan]

What kind of documentation are you working on, and how can I contribute to it ?

[PrabhanshuAttri]

I haven't started it yet. The document will be pretty basic just like this. It will be hosted here. Here are some guidelines to follow: Link.

[PrabhanshuAttri]

@sigmapie8 would you like to do this?

[sigmapie8]

sorry , busy nowdays. I'll take time.

[mathagician]

@PrabhanshuAttri I want to start my open source journey with this project. can u please guide me.

[PrabhanshuAttri]

@mathagician Sure. Read about it here. Let me know if you are not familiar with git.

[krishamehta]

Are you still working on this? I would like to help.

[PrabhanshuAttri]

@krishamehta Awesome. Send a PR. Please include help command from README.md.

[krishamehta]

Will do.

[krishamehta]

Getting an error which says The Travis CI build failed. What should I do?

[PrabhanshuAttri]

@krishamehta You can read about python package structure here. I believe Travis build was not your fault. Just push your code to your forked repo and let us know here. We will help you.

[krishamehta]

You just want me to fork the repo first? Sorry I'm new to open source.

[PrabhanshuAttri]

Yes, please fork it. No worries. Please go through the following links to learn more:

1. Hello World
2. https://guides.github.com/

Must do: Fun with git

[krishamehta]

Done forking it. Thanks a lot.

[krishamehta]

What next?

[PrabhanshuAttri]

@krishamehta you have created the file for Travis CI. This is a different issue. In documentation, you have to create a directory named 'docs' and add few web pages which will be hosted here. Also travis.yml doesn't have the correct configurations. Please work on the documentation. #13 is assigned to someone else.

Let me know if you need help.

[agdhruv]

Hello @PrabhanshuAttri This seems like a good project to start open source contribution. Could you help me with what I can do?

[PrabhanshuAttri]

@agdhruv Please read the description and send a PR.

[thakkardharmik]

@PrabhanshuAttri Is this is open? Suggest me what needs to be done in that case.

[PrabhanshuAttri]

@thakkardharmik Yes, this is available. Visit this link to know about Python package documentation guidelines. You can join our slack channel here

[PrabhanshuAttri]

Hi @thakkardharmik Just touching base for a quick update on this. Thanks.

[akshay-verma]

@PrabhanshuAttri Please find the PR #58 for this.

[PrabhanshuAttri]

Thanks @akshay-verma. This has been pending for a long time. Please check my comments and update the PR so that I can merge it soon. :)

[PrabhanshuAttri]

Please join our new slack channel here.

@Depau @rivermont @fatimarafiqui @schedutron @thomasstep @sestus @AtriTripathi @thornjad @akshay @ashleyyy94 @campionfellin @sachinlohith @savitoj98 @dhruvhacks