cozy / cozy/cozy.github.io

Last update date

Open
#95 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
88
Forks
47
PR merge metrics
No merged PRs in 30d

Description

It would be nice to have on every page a last update date to know if the article is potentially out of date. We could maybe leverage the meta attributes of the markdown.

To test:

  1. Use the on_files event through a plugin to check the last update date via git and add it to the meta information of the file (https://www.mkdocs.org/user-guide/plugins/#on_files), this would not work for external docs since git information is lost when documentation files are copied from the external repository to the src repository
  2. Change the template to display this information through the page.meta Jinja variable: https://www.mkdocs.org/user-guide/custom-themes/#pagemeta

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the MkDocs on_files plugin event and the custom-theme page.meta Jinja variable described in the issue. Determine how the last update date can be added from git metadata, then verify that the custom theme displays it on every page while accounting for external documentation without git history.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, markdown, python
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.