Skip to content

Add run-readme.sh validation script#1

Closed
Copilot wants to merge 4 commits intomainfrom
copilot/add-readme-file
Closed

Add run-readme.sh validation script#1
Copilot wants to merge 4 commits intomainfrom
copilot/add-readme-file

Conversation

Copy link

Copilot AI commented Jan 17, 2026

Implements "run README.md" by creating a validation script that programmatically verifies README structure and completeness.

Changes

  • Added run-readme.sh that validates:
    • File existence and non-empty content
    • Presence of required markdown headers (Introduction, Getting Started, Installation, Launching)
    • Exits 1 on validation failure, 0 on success

Usage

./run-readme.sh
# ✓ README.md exists
# ✓ README.md is not empty
# ✓ Section 'Introduction and Overview' found
# ...
# README.md validation complete!

Can be integrated into CI/CD to ensure documentation quality gates.

Original prompt

run README.md


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 3 commits January 17, 2026 06:46
Co-authored-by: gualagotti <244790138+gualagotti@users.noreply.github.com>
Co-authored-by: gualagotti <244790138+gualagotti@users.noreply.github.com>
Co-authored-by: gualagotti <244790138+gualagotti@users.noreply.github.com>
Copilot AI changed the title [WIP] Add README.md file to project Add run-readme.sh validation script Jan 17, 2026
Copilot AI requested a review from sil3ntwrld January 17, 2026 06:48
@sil3ntwrld
Copy link
Owner

@copilot bash run-readme.sh

Copy link
Author

Copilot AI commented Jan 17, 2026

@copilot bash run-readme.sh

The script runs successfully:

Running README.md validation...
✓ README.md exists
✓ README.md is not empty
✓ Section 'Introduction and Overview' found
✓ Section 'Getting Started' found
✓ Section 'Installation' found
✓ Section 'Launching the CLI' found

README.md validation complete!

Exit code: 0

@sil3ntwrld sil3ntwrld closed this Feb 4, 2026
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.

2 participants