Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move written docs to rizinorg/cutter.re #2056

Open
ITAYC0HEN opened this issue Feb 10, 2020 · 5 comments · May be fixed by #2399
Open

Move written docs to rizinorg/cutter.re #2056

ITAYC0HEN opened this issue Feb 10, 2020 · 5 comments · May be fixed by #2399
Assignees
@xarkes
Labels
Documentation

Comments

@ITAYC0HEN
Copy link
Member

Is your feature request related to a problem? Please describe.

Currently, the written documentation (features, shortcuts, how to build a plugin,...) is laying inside radareorg/cutter. While currently the documentation is short, we are mature and stable enough to make the first steps toward a more comprehensive documentation, and this is currently work in progress.
The upcoming documentation will likely contain more pages and text, in addition to dozens of images and screenshots. There is no need that all this data will be on Cutter repository.

Describe the solution you'd like

Move all the documentation, except the API docs, to radareorg/cutter.re
@thestr4ng3r
Copy link
Member

What if we make a 3rd repo "cutter-docs" that has all the written docs and includes the regular cutter repo as a submodule.
Every master push to it re-generates the html docs and pushes it to cutter.re.
And every push to master on cutter updates the submodule on cutter-docs.

@ITAYC0HEN
Copy link
Member Author

Can't it work with rdareorg/cutter.re without a 3rd one?

@thestr4ng3r
Copy link
Member

It might work too if the sphinx generation process is moved from cutter's ci to cutter.re.

@thestr4ng3r
Copy link
Member

However I think it should be possible to generate the documentation locally without cloning the website repo since by itself it has nothing to do with it.

@karliss
Copy link
Member

karliss commented Mar 12, 2020

I agree. Documentation and website are two different things. We might decide to redo the website from scratch that shouldn't affect documentation. We might also want to include documentation as part of binary packages in which case it would be generated as part of build process.

@Surendrajat Surendrajat mentioned this issue Jun 27, 2020
Merged
3 tasks
@Surendrajat Surendrajat mentioned this issue Jul 26, 2020
Open
3 tasks
@karliss karliss linked a pull request Aug 18, 2020 that will close this issue
Draft
3 tasks
@Surendrajat Surendrajat changed the title Move written docs to radareorg/cutter.re Move written docs to rizinorg/cutter.re Mar 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@xarkes xarkes

Labels
Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Remove user docs from cutter repository karliss/cutter
4 participants
@thestr4ng3r @karliss @xarkes @ITAYC0HEN