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

Documentation #33

Open
znepb opened this issue Feb 15, 2023 · 2 comments
Open

Documentation #33

znepb opened this issue Feb 15, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@znepb
Copy link

znepb commented Feb 15, 2023

https://plethora.madefor.cc is out-of-date, as well as very incomplete in terms of method reference. A new documentation site really should be made.

@Lemmmy
Copy link
Member

Lemmmy commented Mar 18, 2023

I don't think we need to go as far as making a new documentation site, since most of the information there is still relevant, useful, and well-written. But I'm not sure what the best approach to retaining both 1.12 and 1.19 documentation is going to be. Probably a copy of the site with a version tab on the top?

The main reason this hasn't been done yet is because I never ended up porting over the docs/reference generator, since we no longer use the ASM-based method registration. That said, I do still provide (hopefully accurate) docstrings for almost all methods Plethora adds, it's just that their context is somewhat lost compared to before.

@Lemmmy Lemmmy added the documentation Improvements or additions to documentation label Mar 18, 2023
@Lemmmy Lemmmy self-assigned this Mar 18, 2023
@znepb
Copy link
Author

znepb commented Mar 29, 2023

Maybe we could use Illuaminate, similar to CC:T? I'm not sure if it would work with Fabric, but it has worked well with CCT so it should work.

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

No branches or pull requests

2 participants