software-mansion
bug: scarb doc trait documentation should be displayed in parent module
Problem
https://docs.swmansion.com/scarb/corelib/core-boolean.html#traits
The trait documentation should appear in the parent module. Otherwise, we can't simply read the module and understand its entire content.
Steps
No response
Possible Solution(s)
No response
Notes
No response
Version
No response
@enitrat do I understand correctly you would like to see the entire documentation of sub-items on their parent documentation page? and not have the sub-item page at all?
The ideal way is to have a UI similar to rust's stdlib or fuel's stdlib:
A list of items present in the module, along with the first paragraph of doc attached. you can click on the item to get more information. e.g. https://fuellabs.github.io/sway/master/std/asset/index.html
I personally think the mdbook format is not adapted at all to represent a reference of the corelib and is hardly usable / navigable today :/
The example you gave indeed looks like a great solution. Many scarb doc improvements are about to be merged. One of them reorganises how the sub-item page looks like. You can already check it out if you want. I attach the screenshot of what it will look like.
Please share if you have any thoughts on that 🙏
Ah, this is already much better!
I would like to see the list of all items inside the sidebar
https://github.com/user-attachments/assets/ec6b9502-4b9d-4260-8a6e-5d01182c2521