Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation on website is hard to follow #820

Open
tonyganchev opened this issue Feb 12, 2024 · 2 comments
Open

Documentation on website is hard to follow #820

tonyganchev opened this issue Feb 12, 2024 · 2 comments
Labels
documentation P3 An issue that we are not working on but will review quarterly

Comments

@tonyganchev
Copy link

tonyganchev commented Feb 12, 2024

Consider the screenshot below. Text in the tables is wrapped aggressively and very hard to read. Can you switch to a var-width layout or come up with alternative doc rendering?
image
Further problem is that the tables are actually overflowing the available space as in:
image

@tonyaiuto tonyaiuto added P3 An issue that we are not working on but will review quarterly documentation labels Feb 12, 2024
@tonyaiuto
Copy link
Collaborator

I'm still hoping stardoc comes up with a new rendering tool.

@dieortin
Copy link
Contributor

Having a sidebar with links to the different rules would also be great, I currently have to jump to the top and back down all the time

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation P3 An issue that we are not working on but will review quarterly
Projects
None yet
Development

No branches or pull requests

3 participants