Even though there is a special_remotes page, description there is quite superficial and does not provide a good overview of various aspects on special remotes
- life cycle, e.g. how they relate to Git remotes -- that they become listed among
git remote
s whenever enabled, that git remotes get the correspondingannex-uuid
assigned when "sensed" or get annex-ignore, how to "disable" an enabled remote (justgit remote remove
) - clearly list commands to operate on the special remotes (initremote, enableremote) or interrogate them (e.g. how to figure out if there is already a special remote with a target uuid but may be not enabled yet, etc)
Without such a documentation it is hard to "on board" new git-annex users and developers.
Hard to say that documentation is ever done, but I've made some improvements and I guess am going to call this done --Joey
The walkthrough has enough to get a user started in the right direction in https://git-annex.branchable.com/walkthrough/#index12h2.
I don't know if https://git-annex.branchable.com/special_remotes is a good entry point for a user to learn the basics of what they are. It's mostly a list, and I doubt most readers make it past the list.
I have expanded it to mention the main commands.