Skip to content

docs: add AI-assisted documentation disclaimer#9

Merged
EsOsO merged 1 commit into
mainfrom
docs/add-ai-disclaimer
Nov 28, 2025
Merged

docs: add AI-assisted documentation disclaimer#9
EsOsO merged 1 commit into
mainfrom
docs/add-ai-disclaimer

Conversation

@EsOsO

@EsOsO EsOsO commented Nov 28, 2025

Copy link
Copy Markdown
Owner

Summary

Added transparency disclaimer to both README and documentation homepage to clarify the nature of AI-assisted content while emphasizing manual review of critical infrastructure code.

Changes

README.md:

  • Added NOTE callout after main header
  • Clarifies documentation is AI-assisted
  • Emphasizes Docker Compose and infrastructure code are manually written/reviewed

docs/index.md:

  • Added similar disclaimer as MkDocs admonition
  • Positioned after "What is Omakase?" info box
  • Consistent messaging with README

Rationale

Provides transparency to users about:

  • ✅ Which content is AI-assisted (documentation/guides)
  • ✅ Which content is manually reviewed (Docker Compose, service configs, infrastructure code)
  • ✅ Emphasis on security and reliability through human verification

This builds trust by being upfront about the use of AI while reassuring users that critical infrastructure configurations receive thorough human review.

Preview

README

> [!NOTE]
> **About This Documentation**: The documentation and guides in this project 
> are AI-assisted. However, all Docker Compose configurations, service 
> definitions, and infrastructure code are manually written and reviewed by 
> the maintainer to ensure security, reliability, and correctness.

Docs Homepage

Uses MkDocs admonition format with similar content.

Type of Change

  • Documentation update
  • Transparency/disclosure

🤖 Generated with Claude Code

Added disclaimer to README and documentation homepage to clarify:
- Documentation and guides are AI-assisted
- Docker Compose configs and infrastructure code are manually written
  and reviewed by maintainer
- Ensures transparency about content generation while emphasizing
  security and reliability of core configurations

This provides transparency to users while highlighting that critical
infrastructure code receives human review and verification.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

📚 Documentation Build Report

✅ Documentation built successfully!

Site size: 6.0M

Preview: Documentation will be deployed to GitHub Pages after merging to main.
Current site: https://esoso.github.io/Omakase/

Build details
  • Workflow run: 19758665960
  • Commit: 0e25646
  • Python version: 3.11
  • MkDocs Material theme: Latest

@EsOsO
EsOsO merged commit 569cdd3 into main Nov 28, 2025
2 checks passed
@EsOsO
EsOsO deleted the docs/add-ai-disclaimer branch November 28, 2025 08:48
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