Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Contributing

This site is community-maintained and welcomes contributions.

Reporting bugs / suggesting changes

When filing a bug, please include:

  • exfer --version
  • Exact command + flags
  • Full error message + log context (journalctl -u exfer is great)
  • OS / distro / filesystem

Asking questions

For "is this the right way to do X?" questions, GitHub Discussions: https://github.com/ahuman-exfer/exfer/discussions

For real-time chat, look at the project README for the current community channel.

Contributing docs

The flow is the same as for any GitHub-hosted docs:

  1. Fork the repository.
  2. Edit the markdown under src/.
  3. Verify locally with mdbook build (and mdbook serve --open for live preview).
  4. Open a PR.

Things that get merged quickly:

  • Typo fixes, broken-link repairs.
  • Clearer explanations of existing topics.
  • New community node entries in nodes.toml.
  • New script-pattern walkthroughs that match the existing tone.

Things that take longer:

  • Major restructuring of the sidebar.
  • Adding entirely new top-level sections.
  • Changes to the deployment / hosting setup.

Style notes

  • Optimize for someone who skimmed the intro and is now on this page. Don't reintroduce; do link back.
  • Show runnable commands, not pseudocode.
  • Explain the why at least once per page, then move to the how.
  • Prefer terse over comprehensive. If a section is "nobody cares", cut it.

License

This documentation, like the upstream Exfer source, is MIT-licensed.

Acknowledgements

  • The upstream Exfer maintainers, for shipping working software.
  • Everyone running a community RPC node — the Live Nodes page would be empty without you.
  • The community pool / bridge operators — separately maintained but part of the same ecosystem.