🚀 Feature: Documentation readability
Opened this issue · 1 comments
lmz commented
User Story
As a model user and developer, I am finding the existing web documentation hard to read.
I think it may be largely due to formatting but I think this deserves some attention. We should be able to understand what are properties and variables for a class instance pretty easily and I don't think we do necessarily.
For example, in the below image, the right shows the docstring for HighwayConfig and the properties code. The left shows the html doc and it's obfuscating the properties and their descriptions. The html should be at least as readable as the code + docstring.
Progress:
- Sufficiently defined
- Approach determined
- Tests developed
- User story satisfied
- Doc strings
- General documentation
- Passing tests
Priority
Level of Effort
Resolution Ideas
Project
Who should be involved?
Users:
Reviewers:
Risk
Tests
- Test for...
lmz commented
