docs: Fix repository structure in README to match actual layout
- Remove two incorrect/outdated structure diagrams - Replace with single accurate structure matching current repository - Include .github/, .specify/, .vscode/ directories - Show all spec feature directories (001-gdrive-url-header, 001-sitemap, 002-document-export) - Accurate src/ structure with globalVariables/ and proxyScripts/ subdirectories - Include Specify workflow infrastructure documentation Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
54
README.md
54
README.md
@@ -92,21 +92,6 @@ Rationale defined in constitution:
|
||||
2. **Direct Code Flow**: No dependency injection, no framework magic
|
||||
3. **YAGNI Principle**: No premature abstraction for a focused service
|
||||
|
||||
### Structure
|
||||
|
||||
```
|
||||
src/
|
||||
├── server.js # HTTP server, config loader, validation
|
||||
├── proxy.js # Request handler with FIFO queue integration
|
||||
├── drive-client.js # Drive API integration with 50k limit enforcement
|
||||
├── sitemap-generator.js # Sitemap XML generation with RESTful URLs
|
||||
├── queue.js # FIFO request queue (sequential processing)
|
||||
├── auth.js # Service Account authentication
|
||||
├── logger.js # Structured logging utility
|
||||
├── utils.js # Request ID, validation
|
||||
└── xml-utils.js # XML escaping
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
### Test Structure
|
||||
@@ -209,22 +194,41 @@ All errors return **HTTP status code only** with **no response body** (per speci
|
||||
|
||||
```
|
||||
google-drive-content-adapter/
|
||||
├── .github/
|
||||
│ ├── agents/ # Specify workflow agent definitions
|
||||
│ └── prompts/ # Agent prompt templates
|
||||
├── .specify/
|
||||
│ ├── memory/
|
||||
│ │ └── constitution.md # Project principles and standards
|
||||
│ ├── scripts/
|
||||
│ │ └── bash/ # Specify workflow helper scripts
|
||||
│ └── templates/ # Templates for spec, plan, tasks
|
||||
├── .vscode/
|
||||
│ └── settings.json # VS Code configuration
|
||||
├── config/
|
||||
│ └── default.json # Configuration
|
||||
│ └── default.json # Application configuration
|
||||
├── specs/
|
||||
│ ├── 001-gdrive-url-header/ # Source URL header feature
|
||||
│ │ ├── checklists/
|
||||
│ │ ├── contracts/
|
||||
│ │ ├── spec.md
|
||||
│ │ ├── plan.md
|
||||
│ │ ├── tasks.md
|
||||
│ │ └── ...
|
||||
│ ├── 001-sitemap/ # Sitemap generation feature
|
||||
│ └── 002-document-export/ # Document export feature
|
||||
├── src/
|
||||
│ ├── server.js # HTTP server
|
||||
│ ├── proxy.js # Request handler (monolithic)
|
||||
│ ├── auth.js # Service Account auth
|
||||
│ ├── logger.js # Structured logging
|
||||
│ ├── utils.js # Utilities
|
||||
│ └── xml-utils.js # XML escaping
|
||||
│ ├── globalVariables/
|
||||
│ │ ├── google_drive_settings.json
|
||||
│ │ └── googleDriveAdapterHelper.js
|
||||
│ ├── proxyScripts/
|
||||
│ │ └── proxy.js # Main request handler (monolithic)
|
||||
│ ├── logger.js # Structured logging utility
|
||||
│ └── server.js # HTTP server entry point
|
||||
├── tests/
|
||||
│ ├── contract/ # API contract tests
|
||||
│ ├── integration/ # Integration tests
|
||||
│ └── unit/ # Unit tests
|
||||
├── specs/
|
||||
│ └── 001-drive-proxy-adapter/ # Feature spec, plan, tasks
|
||||
├── .env.example # Environment template
|
||||
├── package.json # Dependencies and scripts
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user