-
Notifications
You must be signed in to change notification settings - Fork 2
docs: clean up repo docs #13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
👋 Greetings, Airbyte Team Member!Here are some helpful tips and reminders for your convenience. Testing This Branch via MCPTo test the changes in this specific branch with an MCP client like Claude Desktop, use the following configuration: {
"mcpServers": {
"connector-builder-mcp-dev": {
"command": "uvx",
"args": ["--from", "git+https://github.com/airbytehq/connector-builder-mcp.git@aj/docs/clean-up-repo-docs", "connector-builder-mcp"]
}
}
} Testing This Branch via CLIYou can test this version of the MCP Server using the following CLI snippet: # Run the CLI from this branch:
uvx 'git+https://github.com/airbytehq/connector-builder-mcp.git@aj/docs/clean-up-repo-docs#egg=airbyte-connector-builder-mcp' --help PR Slash CommandsAirbyte Maintainers can execute the following slash commands on your PR:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR cleans up and reorganizes the repository documentation to improve readability and developer experience. The changes focus on streamlining content, improving structure, and removing redundancy across the main documentation files.
- Consolidates and simplifies README.md content with better organization and clearer quick start instructions
- Enhances TESTING.md with improved formatting and condensed inspection output description
- Updates CONTRIBUTING.md with better task organization and removes redundant project structure section
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
File | Description |
---|---|
README.md | Major restructuring with simplified overview, clearer quick start section, and removal of redundant development/testing sections |
TESTING.md | Minor formatting improvements and condensed inspection output description |
CONTRIBUTING.md | Enhanced task documentation, improved formatting, and removed redundant project structure section |
Co-authored-by: Copilot <[email protected]>
Important
Auto-merge enabled.
This PR is set to merge automatically when all requirements are met.
Note
Auto-merge may have been disabled. Please check the PR status to confirm.