Skip to content

docs(docs): polish README - 2 fixes [routine:daily-polish]#35

Open
JacobPEvans wants to merge 1 commit into
mainfrom
docs/daily-polish/docs-2026-05-26
Open

docs(docs): polish README - 2 fixes [routine:daily-polish]#35
JacobPEvans wants to merge 1 commit into
mainfrom
docs/daily-polish/docs-2026-05-26

Conversation

@JacobPEvans
Copy link
Copy Markdown
Collaborator

Daily Polish auto-generated PR.

Checks before fix

1/5 passing.

Failing checks:

  • CLAUDE.md stub (no direct useful content, only @AGENTS.md pointer)
  • Repo description empty
  • Config hygiene: renovate.json missing
  • Release hygiene: no published releases

Fixes applied

  • CLAUDE.md: Expanded stub into a proper agent guide — repo overview, quick commands, critical Mermaid conventions, content boundary table. Retains the AGENTS.md cross-reference.

Note: repo description update attempted but failed (token lacks metadata write scope). renovate.json and releases are outside documentation scope and were not touched.

Checks after fix (self-verification)

Re-evaluated against the docs/daily-polish/docs-2026-05-26 branch: improved from 1 → 2 passing.

Provenance

  • Generated by: Daily Polish - cloud routine, daily at 04:00 UTC
  • Triggered: Scheduled run on 2026-05-26
  • Why this PR: docs was selected from the rotation (tiebreaker: empty description, score 1/2); 4/5 checks failed.
  • State: daily-polish-state gist
  • Label: cloud-routine

@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 26, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
jacobpevans 🟢 Ready View Preview May 26, 2026, 4:13 AM

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates CLAUDE.md to provide a comprehensive quick-reference guide for the docs.jacobpevans.com repository, detailing the tech stack, quick commands, critical conventions, repository layout, and content boundaries. A review comment suggests reordering the listed content sections to match the navigation structure defined in docs.json.

Comment thread CLAUDE.md
# CLAUDE.md — docs.jacobpevans.com

@AGENTS.md
Source for [docs.jacobpevans.com](https://docs.jacobpevans.com), a Mintlify-based personal documentation site covering homelab infrastructure, AI development, observability, and security.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The list of content sections should match the navigation structure defined in docs.json (Infrastructure -> Security -> AI Development -> Observability).

Suggested change
Source for [docs.jacobpevans.com](https://docs.jacobpevans.com), a Mintlify-based personal documentation site covering homelab infrastructure, AI development, observability, and security.
Source for [docs.jacobpevans.com](https://docs.jacobpevans.com), a Mintlify-based personal documentation site covering homelab infrastructure, security, AI development, and observability.
References
  1. When listing project directories or content sections in documentation files, ensure the order matches the navigation structure defined in the project's configuration (e.g., docs.json).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cloud-routine Created by a cloud routine

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant