Skip to content

Commit 88102d2

Browse files
Reorganize documentation into docs/ folder
- Move 7 documentation files to docs/ with cleaner lowercase names - Add Table of Contents to README - Update all internal documentation links Files moved: DEPLOYMENT_GUIDE.md → docs/deployment.md ENVIRONMENT.md → docs/environment.md MCP_CLIENT_SETUP.md → docs/setup.md PROJECT_STATUS.md → docs/roadmap.md QUICK_REFERENCE.md → docs/reference.md SANDBOX_LIMITATIONS.md → docs/sandbox.md TESTING_GUIDE.md → docs/testing.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent e610abd commit 88102d2

8 files changed

Lines changed: 43 additions & 21 deletions

File tree

README.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,28 @@ A Domain MCP server that brings natural language domain management to Claude, Cu
1515

1616
> "List my domains" · "Register example.com" · "Set up DNS for mysite.com" · "Enable WHOIS privacy"
1717
18+
---
19+
20+
## Table of Contents
21+
22+
- [Features](#features)
23+
- [Examples in Action](#examples-in-action)
24+
- [Common Use Cases](#common-use-cases)
25+
- [Quick Installation](#quick-installation)
26+
- [Configuration Options](#configuration-options)
27+
- [Usage](#usage)
28+
- [MCP Tools](#mcp-tools-for-domain-management)
29+
- [Development](#development)
30+
- [Testing](#testing)
31+
- [API Quirks & Known Issues](#api-quirks--known-issues)
32+
- [Architecture](#architecture)
33+
- [Documentation](#documentation)
34+
- [FAQ](#frequently-asked-questions)
35+
- [Support](#support)
36+
- [License](#license)
37+
38+
---
39+
1840
## Features
1941

2042
- **🤖 Natural Language Domain Management**: Use AI assistants like Claude and Cursor to manage domains conversationally - no API knowledge needed
@@ -234,9 +256,9 @@ Then configure with absolute path:
234256
- `DYNADOT_SANDBOX` - Set to `"true"` for sandbox testing (default: `"false"`)
235257

236258
**📖 Full Documentation**:
237-
- [MCP_CLIENT_SETUP.md](./MCP_CLIENT_SETUP.md) - Detailed setup guide with troubleshooting
238-
- [ENVIRONMENT.md](./ENVIRONMENT.md) - Complete environment variable reference
239-
- [SANDBOX_LIMITATIONS.md](./SANDBOX_LIMITATIONS.md) - Known sandbox API limitations
259+
- [Setup Guide](./docs/setup.md) - Detailed setup with troubleshooting
260+
- [Environment Variables](./docs/environment.md) - Complete environment variable reference
261+
- [Sandbox Limitations](./docs/sandbox.md) - Known sandbox API limitations
240262

241263
## Usage
242264

@@ -425,18 +447,18 @@ test/
425447
## Documentation
426448

427449
### 📚 Guides
428-
- **[Quick Start Guide](#quick-start)** - Get up and running in 5 minutes
429-
- **[MCP Client Setup](MCP_CLIENT_SETUP.md)** - Detailed setup for Claude Code, Cursor, Claude Desktop
430-
- **[Deployment Guide](DEPLOYMENT_GUIDE.md)** - Local, Docker, remote, and serverless deployment options
431-
- **[Environment Variables](ENVIRONMENT.md)** - Complete guide to all environment variables
432-
- **[Testing Guide](TESTING_GUIDE.md)** - Automated testing with Claude Haiku
433-
- **[Quick Reference](QUICK_REFERENCE.md)** - Common commands and usage patterns
450+
- **[Quick Start](#quick-installation)** - Get up and running in 5 minutes
451+
- **[Setup Guide](docs/setup.md)** - Detailed setup for Claude Code, Cursor, Claude Desktop
452+
- **[Deployment](docs/deployment.md)** - Local, Docker, remote, and serverless options
453+
- **[Environment](docs/environment.md)** - Complete environment variable reference
454+
- **[Testing](docs/testing.md)** - Automated testing with Claude Haiku
455+
- **[Reference](docs/reference.md)** - Common commands and usage patterns
434456
- **[Examples](examples/)** - Code examples for common operations
435457

436458
### 🔧 Development
437-
- **[Contributing Guide](CONTRIBUTING.md)** - How to contribute, API quirks, testing
459+
- **[Contributing](CONTRIBUTING.md)** - How to contribute, API quirks, testing
438460
- **[Changelog](CHANGELOG.md)** - Version history and updates
439-
- **[Project Status](PROJECT_STATUS.md)** - Implementation status and roadmap
461+
- **[Roadmap](docs/roadmap.md)** - Implementation status and roadmap
440462

441463
### 🏗️ Project
442464
- **[License](LICENSE)** - MIT License
File renamed without changes.
File renamed without changes.
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -186,8 +186,8 @@ The AI remembers the conversation:
186186

187187
## Additional Resources
188188

189-
- **Full Setup Guide**: [MCP_CLIENT_SETUP.md](MCP_CLIENT_SETUP.md)
190-
- **Usage Examples**: [examples/](examples/)
191-
- **API Documentation**: [README.md](README.md)
192-
- **Known Limitations**: [CONTRIBUTING.md](CONTRIBUTING.md#api-quirks-to-know)
193-
- **Project Status**: [PROJECT_STATUS.md](PROJECT_STATUS.md)
189+
- **Full Setup Guide**: [setup.md](setup.md)
190+
- **Usage Examples**: [examples/](../examples/)
191+
- **API Documentation**: [README.md](../README.md)
192+
- **Known Limitations**: [CONTRIBUTING.md](../CONTRIBUTING.md#api-quirks-to-know)
193+
- **Roadmap**: [roadmap.md](roadmap.md)
File renamed without changes.
File renamed without changes.
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -363,16 +363,16 @@ You can pass retry configuration via environment variables (requires code modifi
363363

364364
## Getting Help
365365

366-
- **Documentation**: See [README.md](README.md) for full API reference
367-
- **Examples**: Check [examples/](examples/) directory
366+
- **Documentation**: See [README.md](../README.md) for full API reference
367+
- **Examples**: Check [examples/](../examples/) directory
368368
- **Issues**: Report bugs at https://github.com/joachimBrindeau/domain-mcp/issues
369-
- **API Quirks**: See [CONTRIBUTING.md](CONTRIBUTING.md) for known limitations
369+
- **API Quirks**: See [CONTRIBUTING.md](../CONTRIBUTING.md) for known limitations
370370

371371
## Next Steps
372372

373373
Once configured:
374374
1. Start with simple queries like "list my domains"
375375
2. Try searching for domains
376376
3. Experiment with DNS management in sandbox mode
377-
4. Read the [examples](examples/) for more advanced usage
378-
5. Check out [API Quirks](CONTRIBUTING.md#api-quirks-to-know) before editing contacts or unlocking domains
377+
4. Read the [examples](../examples/) for more advanced usage
378+
5. Check out [API Quirks](../CONTRIBUTING.md#api-quirks-to-know) before editing contacts or unlocking domains
File renamed without changes.

0 commit comments

Comments
 (0)