Instapy: Less complex Documentation

[timgrossmann]

The documentation in the README is getting more and more complex. Especially for newer users this can be really intimidating.

Advantages of this feature:

• Beginners will get a quick overview of the basic features that are easy to use and understand
• Advanced users will not loose documentation for the more advanced concepts and the complex combinations
• README will get more organised

Possible ways of achieving this while keeping control:

• Restructure the README into basic infos about InstaPy and create subsections for Basic Features, Advanced Features, and Third Party Features like image detection.
• Create different pages for the different features instead of having everything in the front page README
• Create an external documentation with pydocs e.g.

Bountysource this Issue

---

Feel free to comment with adjustments and improvements

[CamiloB]

is some one already doing this?

[timgrossmann]

@CamiloB I‘ve started to do a few adjustments but would love to see what you come up with :thumbsup:

[timgrossmann]

https://github.com/timgrossmann/InstaPy/pull/4015

[sbug51]

One thing that might be helpful is to divide the read me file into the General settings section and activity section. At the moment they are all the same. Unless I didn't understand the documentation.

[timgrossmann]

@sbug51 Would be awesome if you could give this https://github.com/timgrossmann/InstaPy/blob/8d7fc0ba7b9f6de91b2c2c9ad9791a92d8506c33/DOCUMENTATION.md a glance and add your thoughts to: https://github.com/timgrossmann/InstaPy/pull/4015 😊

[HCWcoder]

Wonderful job @timgrossmann

[sbug51]

amazing!

On Tue, Mar 26, 2019 at 4:08 AM Tim Großmann [e-mail]
wrote:

@sbug51 https://github.com/sbug51 Would be awesome if you could give
this
https://github.com/timgrossmann/InstaPy/blob/8d7fc0ba7b9f6de91b2c2c9ad9791a92d8506c33/DOCUMENTATION.md
a glance and add your thoughts to: #4015
https://github.com/timgrossmann/InstaPy/pull/4015 😊

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/timgrossmann/InstaPy/issues/3570#issuecomment-476434776,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AuGwcGNKaZDlzUEf4MVldWrnPM3WQOusks5vaXLzgaJpZM4ZSPk1
.

--

Arzo Arsalan

[phone]

arzoarsalan.com http://arzoarsalan.com

Dubai, UAE

[timgrossmann]

4015