aetos/doc-forge
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
0.0.8
doc-forge/CHANGELOG.md
Vishesh 'ironeagle' Bangotra 09118115a4
All checks were successful
continuous-integration/drone/tag Build is passing
Details
fix(mkdocs): rebase cross-kind wiki links under directory URLs 
Wiki pages linking to a sibling kind (for example ../lib/...) were emitted verbatim by MkDocs and, with use_directory_urls, resolved into a non-existent <kind>/<kind>/ path. Add a docforge-linkfix plugin (doc-forge 0.0.8) that rebases those links to the repository root.
2026-10-17 17:22:23 +05:30

2.8 KiB
Raw Permalink Blame History

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

0.0.8 - 2026-10-17

Added

  • docforge-linkfix MkDocs plugin (registered via the mkdocs.plugins entry point) that rebases cross-kind relative links — for example ../lib/... written in a wiki page — to the repository root so they resolve to /<repo>/<kind>/ under directory URLs.

Changed

  • The wiki template (mkdocs.wiki.yml) now enables docforge-linkfix; regenerating a wiki config (or passing --refresh) propagates the fix.

Fixed

  • Cross-kind links (../lib/, ../api/, ../wiki/) in generated wikis no longer resolve into a non-existent <kind>/<kind>/ path.

0.0.7 - 2026-10-17

Added

  • py.typed marker for PEP 561 type information.
  • build --refresh flag to rebaseline an existing docs/mkdocs.{kind}.yml from the packaged templates.
  • wiki build kind with navigation derived from the source file structure.
  • --api build mode rendering an OpenAPI reference under docs/api with lib-prefixed navigation.
  • Hand-written wiki, plus doc-forge-generated API reference under docs/lib and MCP bundle under docs/mcp (per-kind MkDocs configs).
  • MIT LICENSE.

Changed

  • Adopted the standard Type A PyPI CI pipeline: a tag == version guard and a quality gate (black, ruff, mypy, pydoclint, pytest).
  • Standardized pyproject.toml (canonical packaging, lint tool config, extras).
  • Pinned the mcp extra to mcp>=1.0.0,<2.0.0 to restore compatibility with the current MCP server API used by doc-forge.
  • Per-kind MkDocs configs (docs/mkdocs.{lib,api,wiki}.yml) are generated only when absent; an existing config is used verbatim (the file wins). Pass --refresh to regenerate it from the templates.
  • The wiki template now uses the mongo-ops look: horizontal navigation.tabs header, blue grey/teal palette, Roboto font, and additional material feature flags. The lib and api templates are unchanged.
  • Docstrings and wiki brought to the GSDFC (Google-style) standard.
  • The dev extra now includes the mkdocs and mcp extras so the quality-gate environment can install and run the full test suite.

Fixed

  • Loader-generated signatures render cleanly and unresolvable aliases are dropped from generated models.
  • Stub fixes for typed API surfaces.
  • import docforge no longer requires the optional mcp dependency; the MCP server imports mcp lazily, matching the MkDocs backend.