Merge the various iidxhookX.md files into a single one.
Detailed description
There is a lot of copy-pasting going on making this tedious to maintain. I just eye-balled this and it looks like most of the information is overalapping anyway. I think the overall maintainability and readability for the user can be improved if we just create a single iidxhook.md and clarify the 2-3 different paths, e.g. for setup, in there.
Benefits
Better maintainability for contributors and readability for the user.
Drawbacks
Hopefully none, but one has to check if the outcome is actually better in regards of the outlined benefits.
Current blockers
None
## Summary
<!--- Provide a general summary of your changes in the Title above -->
Merge the various `iidxhookX.md` files into a single one.
## Detailed description
<!--- Describe your feature in detail -->
There is a lot of copy-pasting going on making this tedious to maintain. I just eye-balled this and it looks like most of the information is overalapping anyway. I think the overall maintainability and readability for the user can be improved if we just create a single iidxhook.md and clarify the 2-3 different paths, e.g. for setup, in there.
## Benefits
<!--- Describe the value/benefits of the feature in detail -->
Better maintainability for contributors and readability for the user.
## Drawbacks
<!--- Describe any drawbacks that might be introduced with this feature -->
Hopefully none, but one has to check if the outcome is actually better in regards of the outlined benefits.
## Current blockers
<!--- Describe any blockers that need to be resolved before implementing this feature -->
None
I feel there should definitely be a iidxhook.md that all iidxhookX.md's should reference but I think merging them all into one is a bit excessive, for example:
iidxhook9 has specific stuff relating to the OS
iidxhook1-3 has specific stuff relating to the sidcode etc
Perhaps keeping the per-hook files would be a better idea with the more generalised parts linking back as a "please see x in iidxhook.md" or something?
In GitLab by @Corin on May 2, 2021, 14:33
I feel there should definitely be a iidxhook.md that all iidxhookX.md's should reference but I think merging them all into one is a bit excessive, for example:
iidxhook9 has specific stuff relating to the OS
iidxhook1-3 has specific stuff relating to the sidcode etc
Perhaps keeping the per-hook files would be a better idea with the more generalised parts linking back as a "please see x in iidxhook.md" or something?
In general, once someone picks this up, they have to just protoype, move things around and see what makes sense and works best. I found it already quite difficult to anticipate just by looking at the files and their content.
That might be a good hybrid, I agree.
In general, once someone picks this up, they have to just protoype, move things around and see what makes sense and works best. I found it already quite difficult to anticipate just by looking at the files and their content.
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Summary
Merge the various
iidxhookX.mdfiles into a single one.Detailed description
There is a lot of copy-pasting going on making this tedious to maintain. I just eye-balled this and it looks like most of the information is overalapping anyway. I think the overall maintainability and readability for the user can be improved if we just create a single iidxhook.md and clarify the 2-3 different paths, e.g. for setup, in there.
Benefits
Better maintainability for contributors and readability for the user.
Drawbacks
Hopefully none, but one has to check if the outcome is actually better in regards of the outlined benefits.
Current blockers
None
In GitLab by @Corin on May 2, 2021, 14:33
I feel there should definitely be a iidxhook.md that all iidxhookX.md's should reference but I think merging them all into one is a bit excessive, for example:
iidxhook9 has specific stuff relating to the OS
iidxhook1-3 has specific stuff relating to the sidcode etc
Perhaps keeping the per-hook files would be a better idea with the more generalised parts linking back as a "please see x in iidxhook.md" or something?
That might be a good hybrid, I agree.
In general, once someone picks this up, they have to just protoype, move things around and see what makes sense and works best. I found it already quite difficult to anticipate just by looking at the files and their content.
In GitLab by @Corin on May 2, 2021, 14:47
Agreed, it might be worth waiting for !94 to be merged in before visting this issue tbh