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

Update docs Introduction section #191

Closed
skirianov opened this issue Jul 8, 2022 · 4 comments · Fixed by #196
Closed

Update docs Introduction section #191

skirianov opened this issue Jul 8, 2022 · 4 comments · Fixed by #196
Assignees
Labels
documentation Improvements or additions to documentation enhancement Enhancement to current features/ behaviors

Comments

@skirianov
Copy link
Collaborator

Which feature you want to improve?

Documentation Introduction section.

What and why you want to improve that feature

It's quite short and doesn't really "buy" potential users.

Points to improve:

  • Write better wording and explain the ideology of the project briefly.
  • Try to fix the online playground to enable hot reload

Potential bugs/ unexpected behaviors

N/A

How to implement the changes

Check the examples of great documentation and implement similar techniques.

Others

N/A

@skirianov skirianov added documentation Improvements or additions to documentation enhancement Enhancement to current features/ behaviors labels Jul 8, 2022
@skirianov skirianov self-assigned this Jul 8, 2022
@skirianov
Copy link
Collaborator Author

@nvh95 as an additional suggestion is to remove Features section completely and add it to the Introduction section.

Will add as separate commit, so we can revert easily if you won't like it ;)

@nvh95
Copy link
Owner

nvh95 commented Jul 10, 2022

@skirianov

Write better wording and explain the ideology of the project briefly.

Absolutely agree

as an additional suggestion is to remove Features section completely and add it to the Introduction section.

I am not very sure at the moment. But I still like the idea of having a separate Features section. We can still mention the features in the Introduction. But if someone doesn't want to read the long text, they can just navigate to the Features page.

Similar docs that have Features pages:

What do you think?

@skirianov
Copy link
Collaborator Author

About the Features it's reasonable to have a separate page when features are so huge as in those projects.

For instance, here are a few screenshots of both versions:

  1. Without Features
Screen.Recording.2022-07-12.at.21.20.24.mov

Still working on wording though 😉

  1. Features section extracted in a separate page

Screenshot 2022-07-12 at 21 21 00

@nvh95
Copy link
Owner

nvh95 commented Jul 12, 2022

@skirianov Wow. It looks incredible 💪💪🦾🦾. Indulge me with your draft PR 😹😹

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement Enhancement to current features/ behaviors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants