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

[Docs] Revamp Docs UI Theme and layout #5759

Closed
mitsos1os opened this issue Jun 17, 2020 · 1 comment
Closed

[Docs] Revamp Docs UI Theme and layout #5759

mitsos1os opened this issue Jun 17, 2020 · 1 comment

Comments

@mitsos1os
Copy link

Suggestion

A documentation framework or custom styles should be applied to make the documentation easier to read as very well done on different frameworks

Use Cases

As discussed in #5550, the chaotically big amount of information found in the documentation page, in combination with its really plain appearance, contribute to making it harder to read through.

Unfortunately I do not have the "stylistic" knowledge or backround to support this, I am just expressing my personal opinion on the matter. Let this issue be a place for anyone stating his opinion regarding the matter, suggesting frameworks, wireframes, etc...!

Related to Documentation Enhancements in #5113

Examples

NestJS 's documentation is a good example of UI Doc theme.

@mitsos1os mitsos1os changed the title Revamp Docs UI Theme and layout [Docs] Revamp Docs UI Theme and layout Jun 17, 2020
@dhmlau dhmlau added the Docs label Jun 18, 2020
@dhmlau
Copy link
Member

dhmlau commented Jun 18, 2020

@mitsos1os, thanks for the suggestion. @achrinza had a similar proposal on the style/format changes in #4632. I'd like to close this issue as duplicate and continue the discussion over there. Thanks.

@dhmlau dhmlau closed this as completed Jun 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants