Skip to content

Contribute

XOEI is MIT-licensed and community-maintained.

Maintainer contact

  • Maintainer: hyperlander
  • Email: maiermarc75@gmail.com
  • Repository: xelis-education

Contribution flow

  1. Fork repository
  2. Create branch
  3. Update content under docs/ (and mirror folders if relevant)
  4. Run local checks:
  5. node scripts/validate-videos.mjs
  6. node scripts/verify-official-links.mjs
  7. node scripts/render-learning-media.mjs
  8. mkdocs build --strict
  9. Open pull request

What to contribute

  • Documentation updates and source-verified corrections
  • New tutorials under docs/tutorials/
  • Developer learning pages under docs/developer/
  • Research notes/checklists under docs/research/
  • Learning-media catalog updates in videos/metadata/catalog.json

Quality standards

  • Cite official XELIS sources for protocol statements.
  • Keep wording neutral and educational.
  • Avoid financial advice.
  • Use concrete, working links (especially for smart-contract docs subpaths).

See CONTRIBUTING.md and CODE_OF_CONDUCT.md in the repository root.