-
Notifications
You must be signed in to change notification settings - Fork 505
[Feature Request] Mark results as poor #99
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
Comments
hello. the current parser extract only code snippets. can you give examples that you expect to see in context7. i would love to improve our parser if you can help. please give the url for the markdown file (in github) that you think the context7 index lacks. |
Sure, here's an example from the repo I entered. It didn't look like the parser went very deep into the repo structure, does it only look at the root directory? Main points I would be looking for: Does it inherit from ISystem instead of SystemBase or MonoBehaviour?
Does it properly Require the components needed for the system?
Does it use the standard best practice for querying entities?
Those are at a very basic level. |
it parses all docs files (.md, .mdx, .txt, .rst, or .ipynb). it does not parse the source code. are those sections documented in any of the markdown files in the project? |
Ahh, only docs files eh, didn't know that. It's a huge repo, they might be, but they might also just link to the Unity docs which aren't hosted on github but on unity.com. I assumed it would parse code files. Guess that's outside the scope (at least as of now). Either way, probably should remove that lib, as well as the next one i tried: context7: repo: That repo has a README.md, which it parsed, and has links to other web pages, but it doesn't seem to follow links and read those docs, as you said it only looks for code snippets, so probably shouldn't be tracked either. |
right now, we can only parse github docs repos. soon we will start parsing docs websites. until then i will remove those as you suggested. |
Hey @sterling000, you can now report documentations you think have problems using the report button next to the refresh button. Thanks again for the suggestion and let us know if you encounter other issues. |
Hello,
I recently heard about Context7, and I'm a game developer who usually works with Unity or Unreal. One of the biggest challenges with recent Unity project teams I've worked on is using DOTS or the EntityComponentSystem architecture Unity is developing.
I know RAG agents have struggled with Unity development and so I wanted to test and see how well Context7 did when given the ECS sample repo which is quite extensive.
It ran and the results can be seen here: https://context7.com/unity-technologies/entitycomponentsystemsamples
The results are terrible. It seemed to completely ignore 80% of the repository, picked some samples related to very very advanced netcode and job scheduling and completely ignored all the fundamentals, it didn't even pick up any of the SystemAPI calls which is generally the foundation of every ECS system with an idiomatic foreach call and SystemAPI.Query<>.
So I'm not here to bash Context7, the documentation unity provides is not great, it doesn't really adhere to web standards for repo structure, it's a mono repo with dozens of projects inside and so I don't fault Context7 for not being able to parse it.
What I AM concerned with, is now that documentation is in there, and anyone who uses Context7 will have their agents influenced by BAD documentation.
Honestly, it would be better to just delete the library from Context7 entirely than leave it in there, which makes me wonder how many other projects has the documentation been parsed with no way to validate that it's accurate and useful.
The text was updated successfully, but these errors were encountered: