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
Add mkdocs documentation #639
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Does it mean the docs can be regenerated via a script and just "put as is" into the readthedocs? We should probably aim for that (?) |
You don't need to do anything to generate them. For readthedocs, you just create a new project, set the and make the url point to this repository. It would then generate what I linked. |
disconnect3d
approved these changes
May 10, 2019
Just going to put the hacky script here for now:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Given that FEATURES.md isn't comprehensive documentation, I thought it might be helpful to have every command documented. I created some documentation using mkdocs for every command we currently have that is an ArgparsedCommand.
I also created some rough categories and put all commands into one of them. These could probably be improved.
If you want to see what the current version looks like, here it is: https://browserpwndbg.readthedocs.io/en/docs/
This was mostly done by a very ugly hacked-together script, so there might be some errors I missed. If there are any, they should be pretty small though. In the future, we should also improve the commands by adding pictures where useful.