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

Improvements to the docs #42

Closed
DmitrySharabin opened this issue Mar 11, 2023 · 2 comments
Closed

Improvements to the docs #42

DmitrySharabin opened this issue Mar 11, 2023 · 2 comments

Comments

@DmitrySharabin
Copy link
Member

It looks like our docs is not in its best shape for now. We should definitely improve it.

It would be nice if we have not only simple “foo-bar” demos but also some sort of real-life-like apps illustrating some of the most common cases. At least the way we see them now.

The API section of the docs seems to be the biggest issue.

@LeaVerou
Copy link
Contributor

@DmitrySharabin could you make this issue more specific and assign appropriate labels or milestone(s)?

@DmitrySharabin
Copy link
Member Author

The API section of the docs seems to be the biggest issue.

It's not an issue anymore. The API section is OK, but the main page. It should have a README. But we already have a separate issue for this.

It would be nice if we have not only simple “foo-bar” demos but also some sort of real-life-like apps illustrating some of the most common cases. At least the way we see them now.

This is also covered in a separate issue.

So, I would close this issue. We have more specific issues to track.

@LeaVerou LeaVerou closed this as not planned Won't fix, can't repro, duplicate, stale Jun 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants