forked from brunoclz/br-acc
-
Notifications
You must be signed in to change notification settings - Fork 16
📋 Improve onboarding documentation for new contributors #45
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
Problem
New contributors face multiple barriers when trying to run EGOS Inteligência locally:
- API keys are confusing — no clear instructions on where to get each key
- No IDE-specific guides — Windsurf and Antigravity users need help
- Setup assumes Docker knowledge — beginners get lost
- No video/visual walkthrough
- Contributing guide is generic — doesn't explain the project structure
What We Need
- Step-by-step video or GIF walkthrough of local setup
- Expand
.env.examplewith inline comments explaining each key + link to obtain - Create
docs/GETTING_STARTED.mdwith visual guide - Add troubleshooting section (common Docker/Neo4j errors)
- Test the setup on a clean machine (Ubuntu 22.04)
- Add architecture diagram (Mermaid or image)
Current State
README was updated (2026-03-03) with API key table and IDE instructions. See docs/SYSTEM_CAPABILITIES_2026-03.md for full system map.
Good First Issue
This is perfect for documentation contributors who want to help without coding!
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed