Modernize Documentation with Recommended MkDocs Plugins

[Kilo59]

Modernize the documentation by adding several high-quality plugins to improve user trust, performance, and accessibility for automated agents. These plugins are also on the roadmap for Zensical, making this a useful preparatory step.

Tasks

1. Add Dependencies
   Add the following to pyproject.toml in the [dependency-groups.docs] section:

• mkdocs-git-revision-date-localized-plugin>=1.2.0
• mkdocs-redirects>=1.2.0
• mkdocs-minify-plugin>=0.8.0
• mkdocs-llmstxt>=0.1.0

2. Configure mkdocs.yml Plugins
   Update the plugins: block with the following configurations:

• Git Revision Date: Adds a "Last updated" date to the bottom of pages using git history.

  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago  # Display as "3 weeks ago"

• Redirects: Manages URL mapping for renamed/moved pages.

  - redirects:
      redirect_maps: {} # Initial empty map

• Minify: Optimizes HTML, CSS, and JS output for faster loading.

  - minify:
      minify_html: true

• LLMStxt: Generates a standardized /llms.txt and /llms-full.txt for AI agent consumption.

  - llmstxt:
      full_output: true

3. Verify Build

• Run uv run mkdocs build.
• Confirm the footer shows a revision date.
• Confirm that site/llms.txt is generated.

Rationale

• llms.txt is essential for providing a machine-readable summary of the site's content for LLMs and coding assistants.
• git-revision-date-localized builds reader trust by showing recent updates.
• minify and redirects are standard best practices for site maintenance and performance.