personal-projects/gitea-mcp-remote
1
0
Fork 0
generated from personal-projects/leo-claude-mktplace
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

[Sprint 01] docs: Create CLAUDE.md and update deployment documentation #27

New Issue
Open
opened 2026-02-03 22:52:16 +00:00 by lmiranda · 0 comments
lmiranda commented 2026-02-03 22:52:16 +00:00
Owner
Copy Link

Create comprehensive project documentation for Claude Code and update deployment guide with new MCP protocol and Docker structure.

Dependencies

  • Blocked by: All previous issues (#19-#26)

Tasks

  • Create CLAUDE.md:
    • Project overview
    • Architecture diagram
    • Development workflows
    • MCP protocol notes
    • Configuration reference
    • Deployment instructions
    • Troubleshooting guide
  • Update DEPLOYMENT.md:
    • Replace custom REST API refs with MCP protocol
    • Update Docker structure (docker/ directory, two services)
    • Update marketplace dependency installation
    • Update Claude Desktop config example
    • Add MCP protocol debugging section
  • Verify documentation accuracy

Acceptance Criteria

  • CLAUDE.md exists with complete project guidance
  • DEPLOYMENT.md updated with MCP protocol references
  • No references to old /tools/list or /tools/call endpoints
  • Docker paths reference docker/docker-compose.yml
  • Claude Desktop config shows /mcp endpoint
  • All code examples are accurate

Implementation Reference

See docs/sprint-proposals/sprint-01-implementation-guide.md - Phase 9, Issues #17-18

Estimated Time: 2-3 hours

Create comprehensive project documentation for Claude Code and update deployment guide with new MCP protocol and Docker structure. ## Dependencies - Blocked by: All previous issues (#19-#26) ## Tasks - [ ] Create `CLAUDE.md`: - Project overview - Architecture diagram - Development workflows - MCP protocol notes - Configuration reference - Deployment instructions - Troubleshooting guide - [ ] Update `DEPLOYMENT.md`: - Replace custom REST API refs with MCP protocol - Update Docker structure (docker/ directory, two services) - Update marketplace dependency installation - Update Claude Desktop config example - Add MCP protocol debugging section - [ ] Verify documentation accuracy ## Acceptance Criteria - `CLAUDE.md` exists with complete project guidance - `DEPLOYMENT.md` updated with MCP protocol references - No references to old `/tools/list` or `/tools/call` endpoints - Docker paths reference `docker/docker-compose.yml` - Claude Desktop config shows `/mcp` endpoint - All code examples are accurate ## Implementation Reference See `docs/sprint-proposals/sprint-01-implementation-guide.md` - Phase 9, Issues #17-18 **Estimated Time:** 2-3 hours
lmiranda added this to the Sprint 01: Core Architecture Correction milestone 2026-02-03 22:52:16 +00:00
lmiranda added the Size/MPriority/MediumComponent/DocumentationType/Documentation labels 2026-02-03 22:52:16 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Component/API
API endpoints, contracts, and integration
 Component/Auth
Authentication and authorization
 Component/Backend
Backend/server-side code
 Component/Backend
Backend service code and business logic
 Component/Core
Core application logic and architecture
 Component/Database
Database schemas, migrations, queries
 Component/Dependencies
Package dependencies and requirements
 Component/Deploy
Deployment, infrastructure, DevOps
 Component/Docker
Docker and containerization
 Component/Docs
Documentation and guides
 Component/Documentation
Documentation and guides
 Component/Frontend
User interface and client-side code
 Component/Infra
Infrastructure and system configuration
 Component/Integration
Integration and end-to-end testing
 Component/Testing
Test infrastructure and frameworks
 Priority/Critical
Critical priority - blocks other work
 Priority/High
High priority items
 Priority/Medium
Medium priority items
 Size/L
Large task (4-8 hours)
 Size/M
Medium task (2-4 hours)
 Size/S
Small task (1-2 hours)
 Tech/Docker
Docker containers and compose
 Tech/FastAPI
FastAPI backend framework
 Tech/JavaScript
JavaScript/Node.js code
 Tech/PostgreSQL
PostgreSQL database
 Tech/Python
Python language and libraries
 Tech/Redis
Redis cache and pub/sub
 Tech/Vue
Vue.js frontend framework
 Type/Build
Build system and dependencies
 Type/Documentation
Documentation updates
 Type/Feature
New feature implementation
 Type/Refactor
Code refactoring and restructuring
 Type/Setup
Initial project setup tasks
 Type/Test
Testing and quality assurance
Complexity/Complex
High uncertainty or many dependencies
 Complexity/Medium
Some unknowns or dependencies
 Complexity/Simple
Straightforward, well-understood
 Effort/L
3-5 days
 Effort/M
1-2 days
 Effort/S
2-4 hours
 Effort/XL
> 1 week
 Effort/XS
< 2 hours
 Priority/Critical
Immediate attention required
 Priority/High
Important, needs attention soon
 Priority/Low
Nice to have, can wait
 Priority/Medium
Normal priority
 Type/Bug
Something isn't working
 Type/Chore
Maintenance tasks
 Type/Documentation
Documentation improvements
 Type/Feature
New feature or request
 Type/Refactor
Code refactoring without changing behavior
 Type/Test
Testing related
No Label Component/Documentation Priority/Medium Size/M Type/Documentation
Milestone
No items
No Milestone Sprint 01: Core Architecture Correction
Projects
Clear projects
No project
Assignees
Clear assignees
lmiranda
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: personal-projects/gitea-mcp-remote#27
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?