Skip to content

Outdated README, Unclear directory structure, No contribution guidelines#31

Open
navyajain7105 wants to merge 1 commit intohumanai-foundation:masterfrom
navyajain7105:feature/readme-nd-structure
Open

Outdated README, Unclear directory structure, No contribution guidelines#31
navyajain7105 wants to merge 1 commit intohumanai-foundation:masterfrom
navyajain7105:feature/readme-nd-structure

Conversation

@navyajain7105
Copy link
Copy Markdown

Key Issues Found

  1. Outdated README - Only mentions ML4SCI, doesn't reflect the full scope
  2. Inconsistent branding - References to ML4SCI, HSF, and HumanAI mixed throughout
  3. No development documentation - Missing setup, build, and contribution instructions
  4. Unclear directory structure - Mix of prefixed collections (_gsoc*, _gsdocs*, etc.) without explanation
  5. No contribution guidelines - Users don't know how to contribute
  6. Limited comments - Complex Jekyll configuration lacks documentation

Files Added:

  • ✅ Updated README.md - Comprehensive guide
  • ✅ Created CONTRIBUTING.md - Contribution guidelines
  • ✅ Created STRUCTURE.md - Directory structure guide

@Srishti-1806
Copy link
Copy Markdown

Impressive !!!

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

Successfully merging this pull request may close these issues.

2 participants