Wiki updates

[frnjjq]

I am reviewing the project wiki. I have see it is a little outdated and i would like to help with documentation.

I am wondering about the state of the wiki. ¿Can the wiki be updated or it is completely abandoned?.

¿Can I post here somehow in order to update the wiki content?

I also thing it would be beneficial to move it out as it gets updated. I propose use the wiki integrated here in github as it is convenient and near to the source code. ¿Will be pull request generating documentation here well received by maintainers? ¿Is it any way of updating the documentation that fits better the project?

[Vollstrecker]

Any help is welcome

[frnjjq]

So far I got to use wget in order to download the Wiki so I can keep it in case of the hosting completely shuts down.

Right now I am wondering what strategy would be the best in order to incorporate the information. I am weighting up:

• Markdown files under /docs
• New HTML files to be server over github pages. Maybe using some doc generation tool as docsaurus
• Dump the wiki HTML so it can be server over github pages
• Use a tool free to use to open source projects as https://about.readthedocs.com

I am not sure, I am new contributing to this project what kind of PR would be better received. ¿Could someone provide some guidance?

Cheers

[Vollstrecker]

Markdown under docs/ would insert a whole lot of files cluttered over in the source. I don't have the rights to activate the wiki here, so that option falls out.

So if github-pages works, this would be the best solution. If this is generated by some tool or handwritten is up to you.

[frnjjq]

I got to download the complete Wiki on my PC. Happy to send to anyone requesting me this.

I have done a recap of the documentation for the project available:

Wiki: http://wiki.amule.org/

• Use cases: Help for non-technical users. Documentation for technical users. Documentation for contributors.
• Failing as we all know.

Manpages: Under /doc/man

• Use cases: Help for technical uses that launch from the terminal.

Text files: Under /doc

• Here there are several files documenting things as the EC protocol. Maintainers of the project. Olds readme's and random files that appeared there over the years I guess.
• Help for technical users and contributors

Doxygen:

• Ready to be generated but not hosted anywhere ¿May I be wrong?
• Help for maintainers of the project.

Then, what i would consider the to-be state of the project in order to organise this documentation better: Have two main documentations one for technical users and one for non-technical users.

• I would continue using Doxygen as documentation for technical users but:

  • Adequate random text files under /doc to be included in the generated doxygen doc.
  • Incorporate into the Doxygen documentation the technical articles from the Wiki that make sense to be there.

• I would add a external doc as readthedocs into the project for non-technical users.

  • We would need access to the project admin access (to set up webhooks for automatic building) and only @gonosztopi and @sc0w have the rights.
  • Then create the required files and configurations in the repositories to generate the doc using Sphinx and readthedocs hooks.

Then I have two questions:
Will you merge pull requests targeting the documentation in order to include random txt files in /doc it in the doxygen documentation?
Will any emule org admin be willing to continue to generate and link a readthedocs website?