Skip to content

chore: Open Source Repository Standards Overhaul (Phase 1)#181

Merged
DevanshuNEU merged 4 commits into
OpenCodeIntel:mainfrom
DevanshuNEU:chore/oss-standards-overhaul
Jan 8, 2026
Merged

chore: Open Source Repository Standards Overhaul (Phase 1)#181
DevanshuNEU merged 4 commits into
OpenCodeIntel:mainfrom
DevanshuNEU:chore/oss-standards-overhaul

Conversation

@DevanshuNEU

Copy link
Copy Markdown
Collaborator

Open Source Repository Standards Overhaul

Phase 1 of making OpenCodeIntel meet industry standards. Focuses on cleanup and organization.

Closes #180 (partial)


What Changed

Removed (Cleanup)

  • legacy/ folder - old unused code
  • SETUP_COMPLETE.md - internal doc
  • docs/HANDOFF-114.md - internal handoff
  • docs/TIER_SYSTEM_DESIGN.md - internal design doc

Moved (Better Organization)

From To
DEPLOYMENT.md docs/deployment.md
DOCKER_QUICKSTART.md docs/docker-quickstart.md
DOCKER_TROUBLESHOOTING.md docs/docker-troubleshooting.md
docs/MCP_SETUP.md docs/mcp-setup.md

Root folder is now cleaner. All guides live in docs/.

Added (Developer Config)

  • .nvmrc - Node.js 20
  • .python-version - Python 3.11
  • .editorconfig - Consistent code style
  • .github/dependabot.yml - Automated dependency updates

README Overhaul

  • Renamed project to OpenCodeIntel (consistent branding)
  • Added CI/license/release badges
  • Added Quick Links navigation
  • Removed all emoji headers
  • Cleaner structure: features → quickstart → docs → contributing
  • Placeholder for logo and demo screenshot (coming soon)
  • Cut the fluff - 146 lines vs 302 before

Fixed

  • Internal doc links updated to new paths
  • CONTRIBUTING.md updated with correct repo name

Before/After

Root folder:

Before: 17 files (cluttered)
After:  12 files (clean)

Docs folder:

Before: 3 files (mixed internal/public)
After:  4 files (all public guides)

Still TODO (Phase 2)

  • Add logo
  • Add demo screenshot
  • Enable GitHub Discussions
  • Create GitHub Release v0.1.0
  • Add ROADMAP.md

Commits

  • 4d908a0 chore: remove legacy code and internal docs
  • c8f721f chore: reorganize docs - move deployment guides to docs/
  • 48de6b0 chore: add developer config files
  • ca7ed95 docs: complete README overhaul and fix internal links

- Remove legacy/ folder (old unused code)
- Remove SETUP_COMPLETE.md (internal doc)
- Remove docs/HANDOFF-114.md (internal handoff)
- Remove docs/TIER_SYSTEM_DESIGN.md (internal design doc)

Part of OpenCodeIntel#180
- Move DEPLOYMENT.md → docs/deployment.md
- Move DOCKER_QUICKSTART.md → docs/docker-quickstart.md
- Move DOCKER_TROUBLESHOOTING.md → docs/docker-troubleshooting.md
- Rename MCP_SETUP.md → docs/mcp-setup.md (consistent naming)

Cleaner root directory, all guides in one place.

Part of OpenCodeIntel#180
- Add .nvmrc (Node 20)
- Add .python-version (Python 3.11)
- Add .editorconfig (consistent code style)
- Add .github/dependabot.yml (automated dependency updates)

Makes contributor setup easier and keeps dependencies fresh.

Part of OpenCodeIntel#180
README.md:
- Rename to OpenCodeIntel (consistent branding)
- Add badges (CI, license, release)
- Add Quick Links navigation
- Remove emoji headers
- Cleaner structure: features → quickstart → docs
- Leave placeholder for logo and demo screenshot
- Concise, no fluff

CONTRIBUTING.md:
- Update repo name to opencodeintel
- Remove emoji

docs/:
- Fix cross-references to renamed files
- Convert to proper markdown links

Part of OpenCodeIntel#180
@vercel

vercel Bot commented Jan 8, 2026

Copy link
Copy Markdown

@DevanshuNEU is attempting to deploy a commit to the Dev's projects Team on Vercel.

A member of the Team first needs to authorize it.

@vercel

vercel Bot commented Jan 8, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Review Updated (UTC)
opencodeintel Ignored Ignored Preview Jan 8, 2026 11:54pm

@DevanshuNEU DevanshuNEU merged commit 2f078fd into OpenCodeIntel:main Jan 8, 2026
6 checks passed
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.

chore: Open Source Repository Standards Overhaul

1 participant