Remove user docs from cutter repository

[karliss]

Will be moved to separate repository.

Your checklist for this pull request

• [x] I've read the guidelines for contributing to this repository
• [x] I made sure to follow the project's coding style
• [ ] I've updated the documentation with the relevant information (if needed)

Detailed description

Remove the non code docs and add github action for building and uploading doxygen docs to radareorg/cutter.re

I have made a repository containing only docs here https://github.com/karliss/cutter-docs . It has the history and tags preserved, and also the changes to build and upload docs to radareorg/cutter.re .

Remaining work:

• Discuss code documentation placement in cutter.re
• Recreate the cutter-docs repo to include latest documentation changes from cutter master, once rest of the tasks are resolved
• Update the upload paths, currently uploading to test repo to debug the scripts
• Configure the secrets and deploy key for deploy scripts to work (only owners can do this)

Test plan (required)

Closing issues

Closes #2056

[karliss]

I would like to hear the opinion about folder structure where to place doxygen output. I think it should be done keeping in mind that in future we might want to have multiple copies of it one for latest master and one for tag . Maybe seperate one which includes all the private stuff for Cutter developers and contributors as an alternative approach for exploring the code base.

Both due to versioning considerations and simplfying the upload process it would be easier to have it outside the folder uploaded by cutter-docs -> cutter.re/docs folder. To minimize the existing link breakage I don't think the regular docs should be moved.

I suggest something like:

• cutter.re/docs -> content doesn't change
• cutter.re/doc/api/latest -> doxygen output, we can later decide what latest means

This allows in future adding if necesarry

• cutter.re/doc/[something?]/(version|latest|stable) - versioned main documentation
• cutter.re/doc/api/version - versioned api doc
• cutter.re/doc/(doxygen|code-all)/(latest) - doxygen output from all the code including internal parts

Alternative approach might be to upload it to separate folders as suggested above but do some jekyll config magic to ensure that it appears bellow cutter.re/docs/something when visiting the side. I don't think that's worth it.

[ITAYC0HEN]

Having both /docs and /doc is a big no-no. Every UX person will tell you that. Will attend this issue later on the coming week wit more thoughts. But overall, I agree with using versioning and I am fine with splitting things to different tress, although I'd love keeping to only /docs and then add folder on top of it.

Alternatively, we can have docs.cutter.re

[karliss]

If you are the completely against having docs+doc. Then how about the approach of moving some things to the top level that is cutter.re/api/latest`?

If you consider URL an interface then an important property of it that links should remain valid as much as possible.

What problem do you want to solve using subdomain? a) havbe both dos.cutter.re and cutter.re/docs -> same problem as with docs+doc b) create docs.cutter.re and remove cutter.re/docs -> older links to documentation are broken. If you are fine breaking links we might as well reorganize the structure bellow cutter.re/docs to support versions and easier uploading.

[ITAYC0HEN]

If you are fine breaking links we might as well reorganize the structure bellow cutter.re/docs to support versions and easier uploading.

I am fine with breaking docs structure at this point :) Just need to google-search and Github-search properly before

I am not at all against https://cutter.re/api/latest

[Surendrajat]

@karliss @ITAYC0HEN is it a good time to address this one too? :)