Skip to content

Improved README with architecture, setup, and contribution guidelines#194

Open
Shubham1905s wants to merge 1 commit intodifferent-ai:devfrom
Shubham1905s:docs/readme-improvements
Open

Improved README with architecture, setup, and contribution guidelines#194
Shubham1905s wants to merge 1 commit intodifferent-ai:devfrom
Shubham1905s:docs/readme-improvements

Conversation

@Shubham1905s
Copy link

This PR improves the project README by:

  • Adding detailed architecture overview
  • Documenting local/remote OpenCode integration
  • Improving development setup instructions
  • Clarifying plugin system usage
  • Adding contribution and security sections

No code changes included — documentation only.

Happy to update if needed 🙂

@github-actions
Copy link
Contributor

The following comment was made by an LLM, it may be inaccurate:

@benjaminshafii
Copy link
Member

Automated message: thanks for the doc pass. A few accuracy issues need correction before merge:

  • UI is SolidJS, not React.
  • Default contribution base is dev (not main).
  • The repo does not have .opencode/skill/prd-conventions/SKILL.md here; please reference the actual OpenWork PRD convention or remove that pointer.
  • Double-check paths and terms to align with AGENTS.md/MOTIVATIONS-PHILOSOPHY.md (avoid adding new abstractions).

Once corrected, I’m happy to re-review.

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