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

Reorganize docs #366

Open
gibson042 opened this issue Nov 11, 2015 · 5 comments
Open

Reorganize docs #366

gibson042 opened this issue Nov 11, 2015 · 5 comments

Comments

@gibson042
Copy link
Member

README.md should focus first (and most strongly) on using Sizzle, since it gets rendered into https://www.npmjs.com/package/sizzle . This includes API documentation currently in the wiki.

Remaining contents would be better placed in CONTRIBUTING.md and linked to from README.md.

@JuanMaRuiz
Copy link
Contributor

Hi @gibson042 I know this is an old issue but do you still need help fo fix it? How can I help? What is the structure do you think is the correct one?

JuanMa

@gibson042
Copy link
Member Author

Well, taking the content from https://github.com/jquery/sizzle/wiki would be a good start. It's been a while since I've given thought to this issue, and I still expect to replace Sizzle within jQuery this year, but Sizzle itself will always remain valuable as a selector engine implementation.

@JuanMaRuiz
Copy link
Contributor

Many thanks @gibson042 I'll try to do it if you think this change is justified.

Best regards.

@espirit
Copy link

espirit commented May 2, 2020

I just found Sizzle and looked at te github page. It does not show anything about whát sizzle is or does. No I have no clue whether I should look any further.
It would be good to explain in 3 lines what it does, which problem it solves.

@timmywil
Copy link
Member

timmywil commented May 2, 2020

This issue is just about moving the docs from the wiki, which you can find here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

4 participants