docs: add release info to homepage #533
Conversation
|
|
||
| Pebble releases are tracked in GitHub. | ||
|
|
||
| [Read the release notes](https://github.com/canonical/pebble/releases) |
There was a problem hiding this comment.
Missing period at the end?
I can understand the removal of the other two periods below because it is a list of phrases, not a list of sentences. But here it's a standalone sentence in its own paragraph, so I think no matter how long it is (even a single word), it should end with a period?
There was a problem hiding this comment.
Agreed. I'd probably join this sentence with the previous paragraph -- seems to go with that, and a separate paragraph seems unnecessary.
|
|
||
| Pebble releases are tracked in GitHub. | ||
|
|
||
| [Read the release notes](https://github.com/canonical/pebble/releases) |
There was a problem hiding this comment.
Agreed. I'd probably join this sentence with the previous paragraph -- seems to go with that, and a separate paragraph seems unnecessary.
benhoyt
changed the title
|
@dwilding Note the tweak to the PR title for conventional commit style. |
|
@IronCore864, @benhoyt I really want "Read the release notes" to stand alone if possible - I want to treat this link more like a button and have it completely unmissable, not part of text that we expect people to read. (That's also why I would drop the period, because it's a fragment that's not functioning as a sentence) Trying an alternative layout:
If you don't like this, I'll fold 😄 |
|
Let's do it! |
This PR adds a new section called "Releases" to the docs homepage. The purpose is to help newcomers find the Pebble release notes.
Preview build: https://canonical-pebble--533.com.readthedocs.build/en/533/
(While making this change, I also removed a couple of trailing periods in the "Project and community" bullets, for consistency)