nesi / support-docs

NeSI Mkdocs based support pages.
https://docs.nesi.org.nz/
4 stars 5 forks source link

Subscribe to docs site updates in an end user rendered format #234

Open ndjones opened 4 months ago

ndjones commented 4 months ago

In migrating from Zendesk Guide to this beautiful MKDocs site I've lost the ability to track changes in a readable format

I'd like to subscribe to the site or specific pages within the site to track changes over time that might be relevant or more relevant than less

I could subscribe to the underlying repository, and track the changes that come through on various requests etc. This tends to be more technical and in source mark down rather than rendered format. I've looked for examples of how other MKDocs sites do this and haven't found anything yet.

CallumWalley commented 4 months ago

I've had a play with mkdocs-rss-plugin which is quite cool. Generates an item whenever a page is updated.

This fits in with my vision for an 'updates page' essentially just a page that renders several feeds in a nice user friendly, filterable way.

If we have a different channel for each data source, people can subscribe to things on an individual basis.

Channels could include

CallumWalley commented 4 months ago

Also, we can always make more descriptive commit messages. Would make things easier to follow. Could also use tags to separate technical and page updates.