Hardly any documentation available

[nm17]

The current documentation consists of 99% docstrings (No good examples of making modules, commands, etc...). The only good resource for understanding this library is dronesploit, which is hard to understand for a beginner.

Current problems

• No "Getting started" page

• No explanation on how base modules for storage work

• No explanation on how to create modules

• No explanation on how to create examples

• No good full-example project using sploitkit (DroidSploit is too complex and has a lot of features that are specific to it's purpose)

• Only one mentioning of banners in the docs.

• Nothing about datastores and how to use them

• Section "Real-life examples" is broken in the TOC (not broken ; there is simply no page for this TOC entry)

[dhondta]

@nm17 Thank you for mentioning this. Currently, documentation is available at https://sploitkit.readthedocs.io/en/latest/index.html but I'm aware it could be refined.
Do you have an issue or a question in particular ?

[nm17]

In particular, I can't find any information on how to create modules. The example provided in sploitkit-new is not enough.

[nm17]

@dhondta , also https://sploitkit.readthedocs.io/en/latest/base.html is blank for some reason

[nm17]

@dhondta , I've edited the issue accordingly.