Experimental documentation site

Thanks for the feedback, and glad you’re enjoying it.

It does feel a bit like that right now, but that’s because much of what is there was the documentation inherited from our ancient wiki, which was itself extracted form the development tree before that.

The goal is to work towards it covering a wider spectrum, though, and the priority is definitely on the using and publishing side of things.

I’m able to easily increase the maximum post length up to 100kb, but I’m not entirely sure this is a good idea, and it’s also part of the reason why I hadn’t migrated that page yet. It feels too long, both to read and to write, and its formatting also doesn’t feel fantastic.

How about splitting it up in a few pages which are scoped after the subject being covered? It doesn’t have to match 1-to-1 with the URLs. Something vaguely along these lines:

  • Daemon API (versioning details, authentication, and index for subpages)
  • Daemon API - Snaps (snaps, find, aliases, buy)
  • Daemon API - Configuration (not there?)
  • Daemon API - Aliases (aliases)
  • Daemon API - Interfaces (interfaces, connections (missing))
  • Daemon API - Assertions (assertions)
  • Daemon API - Changes (changes)
  • Daemon API - Services (logs, start/stop/etc (missing))
  • Daemon API - Miscelaneous (sections, users, create-user, icons, system-info, snapctl)

This also means we can more easily fix the styling to be pleasant, by doing one page at a time instead of trying to do it all. Conversations around these also become better scoped and more sensible.