Update README.md

README.md

@@ -1,3 +1,114 @@
 ---
 license: apache-2.0
+size_categories:
+- 1K<n<10K
 ---
+
+# GitHub AI Project Docs Dataset
+
+This dataset contains project documentation and README files extracted from top open-source GitHub repositories. It is designed to support research and evaluation of large language models and frontier models—especially for in-context learning using data that lies outside their original training distribution. 
+
+---
+
+## Dataset Overview
+
+- **Source Repositories:** Documentation files are collected from GitHub repositories that:
+  - Use the Apache 2.0 license
+  - Have at least 1,000 stars
+  - Were created within the last 6 months
+- **Content:** Includes various project documentation such as `README.md`, additional markdown files, and related documentation (e.g., recipes, configuration guides).
+
+---
+
+## Key Features
+
+- **Quality & Relevance:** Sourced from popular and actively maintained projects.
+- **Diverse Documentation:** Provides a wide range of writing styles and content formats.
+- **Evaluation Ready:** Ideal for testing the generalization and in-context learning abilities of modern language models.
+
+---
+
+
+### Process Details
+
+1. **Repository Selection:**  
+   Repositories are filtered based on:
+   - License: Apache 2.0
+   - Popularity: 1k+ stars
+   - Recency: Created in the last 6 months
+
+2. **Document Extraction:**  
+   Each repository is crawled to extract documentation files (e.g., `README.md`), including additional project docs.
+
+3. **Aggregation:**  
+   Extracted files are combined into a unified dataset, ready for analysis and model evaluation.
+
+---
+
+## 📚 Example Repositories
+
+Some examples of repositories included in this dataset:
+
+📂 huggingface/open-r1
+⭐ Stars: 19,596
+📝 Description: A fully open reproduction of DeepSeek-R1 with extensive documentation.
+📅 Created: 2025-01-24
+
+📂 raga-ai-hub/RagaAI-Catalyst
+⭐ Stars: 10,374
+📝 Description: Python SDK for Agent AI Observability, Monitoring, and Evaluation Framework.
+📅 Created: 2024-08-26
+
+📂 huggingface/smolagents
+⭐ Stars: 10,361
+📝 Description: A barebones library for agents with associated project docs.
+📅 Created: 2024-12-05
+
+_For a complete list, please refer to the dataset details on the Hugging Face Hub._
+
+---
+
+## How to Use This Dataset
+
+You can load the dataset directly with the Hugging Face `datasets` library:
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("meowterspace42/github-ai-project-docs")
+```
+
+Each entry in the dataset provides both the documentation content and relevant metadata (e.g., repository name, star count, creation date).
+
+---
+
+## License
+
+The documentation files in this dataset are sourced from GitHub repositories under the Apache 2.0 license. Please refer to the individual repository licenses for full details. This dataset is provided solely for research and evaluation purposes.
+
+---
+
+## Citation
+
+If you use this dataset in your research, please cite it as follows:
+
+```bibtex
+@misc{meowterspace42_github_ai_project_docs,
+  title={GitHub AI Project Docs Dataset},
+  author={meowterspace42},
+  howpublished={\url{https://huggingface.co/datasets/meowterspace42/github-ai-project-docs}},
+  year={2025}
+}
+```
+
+---
+
+## Acknowledgements
+
+Thank you to the maintainers of the original GitHub repositories and the Hugging Face community for making these resources available. Your work helps advance research in AI and language modeling.
+
+---
+
+## Contact
+
+For any questions or feedback, please open an issue on the Hugging Face Hub repository