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.

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

Bundle OFRAK docs so they always match GUI version #454

Open
whyitfor opened this issue Apr 18, 2024 · 0 comments
Open

Bundle OFRAK docs so they always match GUI version #454

whyitfor opened this issue Apr 18, 2024 · 0 comments
Labels
enhancement New feature or request reverse-engineering Use case related to understanding unknown binary

Comments

@whyitfor
Copy link
Contributor

What is the use case for the feature?
As an OFRAK User, I want the OFRAK GUI to point to a local version of the docs that are build with the OFRAK GUI.

This will ensure that the docs are always up to date with the GUI version I am using, and will enable using OFRAK Docs without needing an internet connection.

Does the feature contain any proprietary information about another company's intellectual property?
No.

How would you implement this feature?
Consider building and bundling the OFRAK docs with the OFRAK server. This would mean that:

  • PyPI version has docs in it?
  • Docker image GUI references docs that are built when the GUI is built

Are there any (reasonable) alternative approaches?
Perhaps.

Are you interested in implementing it yourself?
Maybe.

@whyitfor whyitfor added enhancement New feature or request reverse-engineering Use case related to understanding unknown binary labels Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request reverse-engineering Use case related to understanding unknown binary
Projects
None yet
Development

No branches or pull requests

1 participant