docs: Add README with examples for CocoIndex projects #1273
Conversation
This README provides an overview of example projects for CocoIndex, including various indexing solutions and their features.
|
Looks nice! Thanks for making this! |
|
Hey, I wanted to mention something for future reference. I actually raised #1268 and was planning to work on it myself. The comment you see here: #1268 (comment) as well as the Contributing docs webpage talks about how folks often should comment something along the lines of The PR feels heavily AI-generated - the structure, PR description format, the note at the end, etc (do let me know if I'm wrong); after having used/reviewed AI-written PRs/code for some time now, there are some patterns you pick up. Using AI tools is fine (atleast imo), but it helps to add your own touch and reasoning to make contribs thoughtful. Just for an example, you could've used GitHub based markdown note admonition at the end of the readme (checkout https://github.com/orgs/community/discussions/16925). AI usually doesn't pick-up stuff like this unless you explicitly mention it. Just something to keep in mind for next time since it helps avoid duplicate work. |
| --- | ||
|
|
||
| > **Note**: New to CocoIndex? Check out the [Getting Started](https://cocoindex.io/docs/getting_started) guide first! | ||
| > | ||
| > **Contribute**: We welcome contributions! Submit a [pull request](https://github.com/cocoindex-io/cocoindex/pulls) to add more examples. |
There was a problem hiding this comment.
Will create a short PR replacing this with appropriate GitHub-markdown-flavoured note admonition.
3 participants
Description
Adds a README overview to the
examples/directory to help users quickly understand what's available in each subfolder.Changes
examples/README.mdwith organized categories