Skip to content

docs: Add troubleshooting section for common installation failures #364

@hasnainmorani700

Description

@hasnainmorani700

Description

The quickstart guide provides installation steps but doesn't include troubleshooting guidance for common failures. New users encountering issues have no immediate recourse except searching through documentation.

Common Issues That Should Be Documented

  1. Node.js version mismatch - What if user has Node 18 instead of 20?
  2. Docker not running - How to check and start Docker?
  3. Permission errors - npm install fails with EACCES
  4. Port conflicts - What if port 5173 is already in use?
  5. Network/firewall issues - Corporate proxy configuration

Expected Behavior

The documentation should include a "Troubleshooting" section or link to comprehensive troubleshooting docs.

Current Workaround

Users must:

  1. Search through docs/troubleshooting.md
  2. Open a GitHub issue
  3. Ask in discussions

Suggested Solution

Add a "Common Issues" section to README.md with:

  • Quick diagnostic commands
  • Links to detailed troubleshooting docs
  • Common error messages and solutions

Example:

## Troubleshooting

### Installation fails with "npm ERR!"
Run: `npm cache clean --force` and try again

### Docker connection refused
Run: `sudo systemctl start docker`

### nemoclaw command not found
Run: `source ~/.bashrc` or add to PATH manually

Additional Context

This would significantly reduce support burden and improve first-time user experience.


**Labels to suggest:**
- `documentation`
- `enhancement`
- `good first issue`

---

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: docsDocumentation, examples, guides, or docs buildarea: installInstall, setup, prerequisites, or uninstall flowarea: onboardingOnboarding FSM, provider setup, sandbox launch, or first-run flow

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions