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

Link the documentation on the AssetLib page and in the asset itself #52

Closed
greenfox1505 opened this issue Jun 28, 2023 · 5 comments
Closed

Comments

@greenfox1505
Copy link

You shouldn't be expected to download the Asset from the AssetLib, then to find the repo, then go find the wiki, then go figure out how to get your project working.

The package downloaded from the AssetLib should include everything you need to get started, including any ReadMe.md for basic use and compiling instructions. Anything more can still be "hey, for more indepth tutorial, go to the wiki linked here!", but Minimum Viable Product, the asset should include instructions.

@greenfox1505 greenfox1505 added the bug Something isn't working label Jun 28, 2023
@paulloz paulloz removed the bug Something isn't working label Jun 28, 2023
@paulloz
Copy link
Owner

paulloz commented Jun 28, 2023

First of all, hello.

I guess that's fair, I actually never considered the AssetLib as an entry point, given how abysmal its discoverability and UX are. I'll update the AssetLib description to include a link to the documentation. And I'll have a glance at what kind of documentation other packages provide in their add-on folder. My gut feeling is, for the most part, documentation that's hosted elsewhere on the internet is the norm.

Thanks for the report.

@greenfox1505
Copy link
Author

Thank you! Even if that documentation is just "please check here(LINK) for the latest documentation", that's a good start.

I think most packages don't actually do a very good job of their AssetLib presence. IMHO, that is a mistake.

My day job is Unity stuff. Unity developers love their plugin store. Godot could be doing a lot better in that aspect.

Thank you for this project. I was looking into write a parser myself before finding your project. I'm currently working on some tooling to make this easier to use from GDScript before kicking off a game jam in a few weeks. If that's something you'd find useful, I'll do a pull request.

@paulloz
Copy link
Owner

paulloz commented Jun 28, 2023

IMHO, that is a mistake.

It's more due to the fact the AssetLib and everything related to it is a PITA. It makes no sense to dedicate actual time to it. Even less so for C# add-ons.

I'm currently working on some tooling to make this easier to use from GDScript before kicking off a game jam in a few weeks. If that's something you'd find useful, I'll do a pull request.

From here, I'm not sure that it's going to be something I'd plan on adding to this project. The goal is to keep the scope fairly minimal. And adding specific tooling for GDS (apart from mandatory interop code) doesn't feel like it'd fall in scope. But feel free to open something with more detail when the time comes, I'll make sure to have a look.

@paulloz paulloz changed the title The AssetLib version should include tutorials or a readme.md that directs users to the wiki here. Link the documentation on the AssetLib page and in the asset itself Jun 28, 2023
@paulloz
Copy link
Owner

paulloz commented Jul 12, 2023

The description on the Asset Library was updated today.

@paulloz
Copy link
Owner

paulloz commented Jul 12, 2023

The addon folder now contains a copy of the README.md file, which contains basic installation instruction, and links to the wiki.

@paulloz paulloz closed this as completed Jul 12, 2023
@paulloz paulloz added the waiting for the next release This issue is resolved but waiting to be released label Jul 12, 2023
@paulloz paulloz removed the waiting for the next release This issue is resolved but waiting to be released label Sep 17, 2023
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

2 participants