infernet-node icon indicating copy to clipboard operation
infernet-node copied to clipboard

Improve Infernet Node README for clarity and usability

Open muizcal opened this issue 3 months ago • 0 comments

Hi Ritual team

The current Infernet Node README is helpful but could be reorganized and expanded for clarity. I’d like to propose some improvements:

Reorder sections: Overview → Prerequisites → Configuration → Deployment → Troubleshooting → Contributor Notes.

Expand config.json instructions with annotated examples of key fields.

Consolidate Docker build steps to avoid duplication.

Add a troubleshooting section (common Docker/GPU/config errors).

Move “Publishing Docker image” to a contributor-only section.

Improve readability with consistent formatting (bullets, headings, warnings).

Benefits

Easier onboarding for node operators.

Reduced support questions.

Clearer separation between operator vs contributor paths.

Happy to open a PR implementing these changes if the team agrees

muizcal avatar Sep 07 '25 21:09 muizcal