Skip to content

chore(docs): reconcile outstanding documentation and tooling work - #3

Merged
choisimo merged 1 commit into
mainfrom
chore/document-release
Sep 8, 2026
Merged

choisimo merged 1 commit into
mainfrom
chore/document-release

Conversation

@choisimo

@choisimo choisimo commented Sep 8, 2026

Copy link
Copy Markdown
Owner

Summary

Bring the outstanding local documentation revisions and tooling work into main, preserving the already published documentation hub and upstream search-focus and Markdown-fence fixes. This includes the existing broad rewrite and condensation of technical articles and archived learning notes, revised indexes, maintenance records, and retained design assets (433 files versus the current base).

Align the public AI environment example with the deployed public configuration boundary, fix the legacy asset-sync entrypoint and Docker paths/ownership, enable the full documentation validator in CI, and correct Java example class names. Fix the screenshot diagnostic so the Hub main content area is accepted alongside the older Material theme.

Replace the Slack webhook credential detected by GitHub push protection with an explicit placeholder. The release commit is based directly on the current origin/main; the original local commits remain preserved locally. Its tree was verified identical to the reviewed, sanitized worktree.

Validation

  • Strict MkDocs clean build: passed; 265 published documents and 21 Compose stacks.
  • Rust validator tests: 10 library and 8 CLI tests passed.
  • Full published-source validation: 1,463 Mermaid parser blocks, 686 links, and Markdown format checks passed across all 265 documents.
  • Python build-hook tests: 6 passed.
  • Node/Chromium QA: 43 passed; after the diagnostic fix, the affected screenshot suite passed all 15 tests, including Hub markup and retained failure/retry checks.
  • Generated content: 18,468 internal URL targets, 5,006 TOC IDs, and referenced stack files resolved.
  • Three changed Java examples compiled independently with javac.
  • Production-profile Docker Compose configuration validated; added-line credential signature scan found no matches.

Limits

The checks validate the configured parser and source/build/browser contracts, not the factual accuracy of every technical article or every diagram in the browser. Live external AI responses and Docker service startup were not exercised. Two existing Compose sources (qbittorrent-advanced and droppy) remain marked as unavailable metadata by the build hook.

Copilot AI lite review requested due to automatic review settings September 8, 2026 15:32
@codoki-pr-intelligence

Copy link
Copy Markdown

Codoki trial ended

This workspace trial has ended, so Codoki paused AI code reviews for this pull request.

Upgrade to Solo or Pro to keep catching risky changes before they reach production.

👉 Choose a plan to continue reviews.

If this is an error, contact us at info@codoki.ai.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@choisimo
choisimo merged commit 415e68d into main Sep 8, 2026
3 checks passed
@choisimo
choisimo deleted the chore/document-release branch September 8, 2026 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants