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

"New in the docs" feed #1460

Open
texnixe opened this issue Aug 14, 2021 · 2 comments
Open

"New in the docs" feed #1460

texnixe opened this issue Aug 14, 2021 · 2 comments
Labels
type: feature 🎉 Adds a feature (requests → feedback.getkirby.com) type: idea 💡 Is a suggestion

Comments

@texnixe
Copy link
Member

texnixe commented Aug 14, 2021

When we add new stuff to the docs, people often miss it. While we post about new cookbook recipes, the rest often goes unnoticed.

For documentation that we add manually, we could use GitHub's API to generate a feed provided we give ourselves a commit message regimen, because typo correction commits and other smaller changes are of course completely useless.

For documentation generated automatically, this of course won't work.

@texnixe texnixe added type: feature 🎉 Adds a feature (requests → feedback.getkirby.com) type: idea 💡 Is a suggestion labels Aug 14, 2021
@distantnative
Copy link
Member

Would it be sufficient to add to the commit messages something like #docs?

And on the feed we would list the commit message (stripped of #docs) as title and link to the GitHub commit?

@bastianallgeier
Copy link
Member

@distantnative we could definitely give it a try like that.

Since we are using the git repo on the server, we could even try to get the commits there directly from the repo and not through the Github API

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature 🎉 Adds a feature (requests → feedback.getkirby.com) type: idea 💡 Is a suggestion
Projects
None yet
Development

No branches or pull requests

3 participants