You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Personally, I find fully working examples the most effective way of understanding concepts and functionality. Fully working but as minimal as possible. There's always a balance between "feature X works like THIS" and a complete example that covers too much, I know. However - I often find myself scratching my head on all the things NOT mentioned in examples.
Promoting this repo and encouraging contribution would greatly enhance the understanding and usability of Piranha - and would put less demand on updating the docs (which I know is lacking in Piranha as well as pretty much every software project on the planet). I don't know how this would be done best but I think this might be a "low hanging fruit" thing to improve Piranha "documentation".
One thing this repo could use is a better overview of what the different modules do. Now we only have a few but if more are added - it would be very useful with some sort of categorization. Perhaps tags for each module, both indicating what parts of Piranha they cover but also what kind of problem they solve. My module, for instance, could have tags like: PIRANHA-MODULE, PIRANHA-HOOKS, IMPROVEMENT-COMMENTS, FEATURE-ANTISPAM, MANAGER-SUPPORT, and perhaps more. I can see contributions to this repo that is not a module too - since the concept of modules is somewhat loosely defined in the Piranha context (without saying that's a good or bad thing).
I won't do a PR for any changes like this but I do believe this repo could be more used and rich in content - with relative little effort from the Piranha team (so they can focus on Piranha itself).
The text was updated successfully, but these errors were encountered:
Personally, I find fully working examples the most effective way of understanding concepts and functionality. Fully working but as minimal as possible. There's always a balance between "feature X works like THIS" and a complete example that covers too much, I know. However - I often find myself scratching my head on all the things NOT mentioned in examples.
Promoting this repo and encouraging contribution would greatly enhance the understanding and usability of Piranha - and would put less demand on updating the docs (which I know is lacking in Piranha as well as pretty much every software project on the planet). I don't know how this would be done best but I think this might be a "low hanging fruit" thing to improve Piranha "documentation".
One thing this repo could use is a better overview of what the different modules do. Now we only have a few but if more are added - it would be very useful with some sort of categorization. Perhaps tags for each module, both indicating what parts of Piranha they cover but also what kind of problem they solve. My module, for instance, could have tags like: PIRANHA-MODULE, PIRANHA-HOOKS, IMPROVEMENT-COMMENTS, FEATURE-ANTISPAM, MANAGER-SUPPORT, and perhaps more. I can see contributions to this repo that is not a module too - since the concept of modules is somewhat loosely defined in the Piranha context (without saying that's a good or bad thing).
I won't do a PR for any changes like this but I do believe this repo could be more used and rich in content - with relative little effort from the Piranha team (so they can focus on Piranha itself).
The text was updated successfully, but these errors were encountered: