Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
ndjones opened this issue May 1, 2024 · 2 comments
Open

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

ndjones opened this issue May 1, 2024 · 2 comments
Labels
feature request Request for new feature

Comments

@ndjones
Copy link
Member

ndjones commented May 1, 2024

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.

@ndjones ndjones added the feature request Request for new feature label May 1, 2024
@CallumWalley
Copy link
Member

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

  • page updates (via mkdocs-rss-plugin).
  • Software updates (via automation that updates supported apps page).
  • Patch notes (manual).
  • Upcoming training/workshops (via calendar api).
  • Status page?

@CallumWalley
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request Request for new feature
Projects
None yet
Development

No branches or pull requests

2 participants