Skip to content

Move doc-guide to an agent skill and tighten it - #58

Merged
volfpeter merged 2 commits into
mainfrom
jinja-layouts
Jul 23, 2026
Merged

Move doc-guide to an agent skill and tighten it#58
volfpeter merged 2 commits into
mainfrom
jinja-layouts

Conversation

@volfpeter

@volfpeter volfpeter commented Jul 23, 2026

Copy link
Copy Markdown
Owner

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive documentation guide covering structure, tone, formatting, links, examples, navigation, and review checklists.
    • Consolidated documentation guidance into the new standard guide location.
    • Removed the previous standalone documentation style guide.

@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 746aacc8-c171-4e61-abcc-ba459ddda40e

📥 Commits

Reviewing files that changed from the base of the PR and between 177ef05 and dcc5e45.

📒 Files selected for processing (2)
  • .agents/skills/documentation-guide/SKILL.md
  • ai/doc-guide.md

📝 Walkthrough

Walkthrough

Adds a documentation skill containing holm writing and publishing conventions, and removes the previous standalone documentation guide.

Changes

Documentation guide migration

Layer / File(s) Summary
Guide scope and writing conventions
.agents/skills/documentation-guide/SKILL.md, ai/doc-guide.md
Adds the documentation skill metadata and conventions for documentation location, tone, formatting, document types, links, examples, and code blocks while removing the former standalone guide.
Document structures and publishing rules
.agents/skills/documentation-guide/SKILL.md
Adds MkDocs navigation guidance and a final checklist for documentation structure, references, code examples, prerequisites, and running instructions.

Estimated code review effort: 2 (Simple) | ~10 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch jinja-layouts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@volfpeter
volfpeter merged commit 8806408 into main Jul 23, 2026
2 of 3 checks passed
@volfpeter
volfpeter deleted the jinja-layouts branch July 23, 2026 19:10
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.

1 participant