edgarfgp
[Proposition] Ideas for improving the documentation
Hello @edgarfgp,
I am using Fabulous.AST to F# generate code.
The documentation seems to cover a lot of cases but difficult to navigate.
Some pages are small enough but others are really verbose. For example, finding information from the Module is not simple.
I think it would help if the documentation was split into smaller blocks, with inner TOC on page for quickly finding what the user is looking for.
Example for the Record page we could see:
- Type definition
- Attributes
- Record instantiation
- Updating record
- Members
- Accessing field value
- etc.
The names of the section would be based on a F# features / what the user want to do. I think some of the proposition above are probably too low level and could cause duplication across the documentation but in theses cases we could try to mutualize with other types.
I am interested in contributing and sending a small PR proposition if you think this is a good idea.
After looking at the tests projects, it felt easier to navigate to me.
Agreed we could have a better structured docs. I would definitely accept PR to improve docs.
