FAQ | This is a LIVE service | Changelog

Skip to content
Snippets Groups Projects

feat: Knowledge base enhancements (diataxis)

Merged Nick Brown requested to merge operation-diataxis into master
  • Add neoteroi mkdocs plugin for various aesthetic extensions (cards, timeline etc.)
  • Add hooks/site_urls.py for site: site-relative linking.
  • Add reusable diataxis neoteroi cards & snippets & images for diataxis quadrants
  • Add knowledge base page detailing diataxis quadrants in new home/ section page
  • Define & integrate reusable admonition snippet & neoteroi card definitions for diataxis ("knowledge quadrants")
  • Convert many page markdown links from relative to now-supported site: form
  • Alphabetise & neaten extensions in mkdocs.base.yml, add stylesheets for neoteroi cards and diataxis related styling
  • Update site page structuring in howtos/ & other diataxis areas so directories reflect navigation structuring for easier management & much smaller doc directory sizes.

Screenshot_2025-03-06_at_20.08.16

Screenshot_2025-03-06_at_20.09.16

Screenshot_2025-03-06_at_20.08.48

Screenshot_2025-03-06_at_20.08.55

Screenshot_2025-03-06_at_20.09.02

Screenshot_2025-03-06_at_20.09.39

Edited by Nick Brown

Merge request reports

Pipeline #714135 passed

Pipeline passed for 1eac9c0c on operation-diataxis

Approved by

Merged by Nick BrownNick Brown 1 month ago (Mar 11, 2025 3:29pm UTC)

Merge details

  • Changes merged into master with 094e8ee8.
  • Deleted the source branch.

Pipeline #714141 failed

Pipeline failed for 094e8ee8 on master

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Nick Brown added 2 commits

    added 2 commits

    • e1caab4c - chore: Add missing markdownlint-enable tag to README
    • 82c76f3e - chore: Add redirects for all relocated pages to mkdocs configuration

    Compare with previous version

  • Nick Brown added 1 commit

    added 1 commit

    • 37207b64 - chore: Remove incompatible .viz file from redirects lits in mkdocs config

    Compare with previous version

  • Nick Brown added 1 commit

    added 1 commit

    • 7a2b5c4b - docs: Update README to clarify new extension & plugin in-page syntax

    Compare with previous version

  • Nick Brown added 1 commit

    added 1 commit

    • 1c3b394c - docs: Fix line length in README

    Compare with previous version

  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Please register or sign in to reply
    Loading