Snap documentation

Hi Robin,

Two suggestions for the format, and one comment about the data:

1. Information is boring

The output is long and boring for most people. It’s okay to have it here as it’s closely related with a table of contents, which is one of the purposes of this page, and having it here also makes it convenient to fetch at once for the dynamic systems. But we don’t need to show it all the time. We can fix that by folding it:

URLs

… content goes here …

Implemented with:

[details=URLs]
... content goes here ...
[/details]

2. Format is hard to read

It’s a lot of data and naturally repetitive. We can probably improve the situation significantly by reformatting it in a more stable way. For example:

Page URL
Creating a snap /creating-a-snap

This is not only shorted, but it’ll turn out a lot more pleasant because the two columns will align. The awkward arrow, which doesn’t align well in the font used here, is also gone.

It’s implemented with:

| Page | URL |
| --- | --- |
| https://forum.snapcraft.io/t/creating-a-snap/6799 | /creating-a-snap |

Then, a third comment on the actual data:

3. Not offering any value

This is a premature comment, but worth raising it now before the data is final. All those links seem to simply point to a URL that uses the exact same text as the title. This doesn’t seem to offer any value, and it’s a lot of trouble for no value. If that’s what we’ll do in 99% of the cases, then it’d be worth asking what the motivation is again.