Skip to content

basic readme and fixed some markdown linting errors#1

Open
rhwas wants to merge 1 commit intomainfrom
feature/readme-and-markdown-formatting
Open

basic readme and fixed some markdown linting errors#1
rhwas wants to merge 1 commit intomainfrom
feature/readme-and-markdown-formatting

Conversation

@rhwas
Copy link
Collaborator

@rhwas rhwas commented Feb 16, 2026

No description provided.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds initial top-level documentation for the Agent Library and cleans up markdownlint-related formatting in existing docs, making setup and usage clearer for consumers of the .claude/ agents/skills.

Changes:

  • Added a new README.md with Quick Start symlink instructions, usage examples, and high-level contents.
  • Adjusted CLAUDE.md markdown formatting (table separators, code-fence language tags, spacing) to address linting.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
README.md Introduces basic project overview, setup instructions, and usage examples.
CLAUDE.md Markdownlint-oriented formatting fixes for tables and code blocks.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +79 to +80
- Claude Code or VSCode Copilot with Claude model
- Git repository in your project
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

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

Same naming issue as earlier: "VSCode Copilot" is ambiguous/misleading compared to "GitHub Copilot" (in VS Code). Updating this phrasing would make the requirements clearer.

Copilot uses AI. Check for mistakes.
Comment on lines +7 to +13
Symlink the folders to your project:

```bash
ln -s ~/AgentLibrary/.claude/agents ~/yourproject/.claude/agents
ln -s ~/AgentLibrary/.claude/skills ~/yourproject/.claude/skills
ln -s ~/AgentLibrary/.claude/rules ~/yourproject/.claude/rules
```
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

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

The symlink commands will fail if the destination .claude/ directory doesn't already exist (e.g., ~/yourproject/.claude). Consider adding a preceding step/command to create the destination directory (or clarify that it must exist) so the Quick Start works when followed verbatim.

Copilot uses AI. Check for mistakes.
@@ -0,0 +1,81 @@
# Agent Library

A collection of reusable agents and skills for Claude Code and VSCode Copilot. Provides autonomous workers for complex tasks like testing, code review, CI/CD debugging, refactoring, and more.
Copy link

Copilot AI Feb 16, 2026

Choose a reason for hiding this comment

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

The README refers to "VSCode Copilot", but the product name is typically "GitHub Copilot" (often used within "VS Code"). Consider rephrasing to avoid implying a separate product and to make the requirement unambiguous for readers.

Copilot uses AI. Check for mistakes.
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