Skip to content

docs: add recent updates JSON feed recipe#447

Open
catwithtudou wants to merge 1 commit into
Guts:mainfrom
catwithtudou:docs/recent-updates-json-feed
Open

docs: add recent updates JSON feed recipe#447
catwithtudou wants to merge 1 commit into
Guts:mainfrom
catwithtudou:docs/recent-updates-json-feed

Conversation

@catwithtudou

@catwithtudou catwithtudou commented Jun 7, 2026

Copy link
Copy Markdown

This PR adds a documentation recipe for building a "Recently updated" page from the JSON feed generated by mkdocs-rss-plugin.

Changes:

  • Add a recipe that renders entries from feed_json_updated.json.
  • Include minimal mkdocs.yml, docs/updates.md, and recent-updates.js examples.
  • Document why the updated feed is used and how to adapt match_path for different documentation layouts.
  • Clarify that length limits how many updates the page can display.
  • Add empty/error handling to the JavaScript example and note that the list is rendered client-side.

Validation:

git diff --check
env MKDOCS_ENABLE_PLUGIN_GIT_COMMITTERS=false MKDOCS_ENABLE_PLUGIN_SOCIAL=false MKDOCS_ENABLE_PLUGIN_PRIVACY=false .venv/bin/mkdocs build --site-dir /tmp/mkdocs-rss-plugin-site-final-2

Build notes:

  • The docs build still reports existing warnings for feed links in index.md and the remote image used by configuration.md.
  • No new build failures were introduced.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 7, 2026
@catwithtudou catwithtudou force-pushed the docs/recent-updates-json-feed branch from 7ffd00d to 4ff2091 Compare June 7, 2026 08:48
@catwithtudou catwithtudou force-pushed the docs/recent-updates-json-feed branch from 4ff2091 to 047d565 Compare June 7, 2026 09:02
@sonarqubecloud

sonarqubecloud Bot commented Jun 7, 2026

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant