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

Improve documentation #9

Open
12 tasks
kabiroberai opened this issue Mar 25, 2021 · 1 comment
Open
12 tasks

Improve documentation #9

kabiroberai opened this issue Mar 25, 2021 · 1 comment

Comments

@kabiroberai
Copy link
Member

kabiroberai commented Mar 25, 2021

  • Fill in stub guides
  • Add more examples
  • Add basic documentation in template, similar to the regular tweak template
  • Describe how to hook classes which can't be linked (@interface, Dynamic, etc.)
  • Add troubleshooting guide (mention handleError, Theos troubleshooting, etc.)

Document QoL features:

  • Automatic @available handling
  • Calling other hooks' supr/orig methods

Document directives:

  • disable
  • new
  • returns_retained
  • supr_tramp
  • Schemas
@kabiroberai
Copy link
Member Author

It was; unfortunately I was pressed on time and didn't want to keep devs waiting when they'd already started making tweaks with Orion. This issue is, of course, still something I plan to get to, however I haven't been able to make much time for it yet due to other work. In the meanwhile, if you need any help with the features mentioned in the issue then feel free to get in touch on the Theos discord server.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant