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 02] docs: Create deployment documentation and configuration examples #16

New Issue
Closed
opened 2026-02-03 21:02:20 +00:00 by lmiranda · 1 comment
lmiranda commented 2026-02-03 21:02:20 +00:00
Owner
Copy Link

Summary

Create documentation and configuration examples for the corrected wrapper implementation.

Tasks

.env.example

  • Create .env.example with all configuration options:
    • GITEA_API_URL (required)
    • GITEA_API_TOKEN (required)
    • ALLOWED_TOOLS (optional)
    • DENIED_TOOLS (optional)
    • AUTH_TOKEN (optional)
    • PORT (optional)
    • HOST (optional)
  • Add inline comments explaining each variable
  • Include example values

CLAUDE.md

  • Create CLAUDE.md for Claude Code guidance:
    • Project overview (deployment wrapper, not standalone)
    • Architecture explanation (imports from marketplace)
    • How to work with this codebase
    • Key files and their purposes
    • Development workflow
    • Docker deployment instructions
    • Troubleshooting guide

README.md Rewrite

  • Rewrite README.md to reflect correct architecture:
    • Clear statement: "Deployment wrapper for gitea-mcp-server marketplace package"
    • Installation instructions
    • Configuration guide (environment variables)
    • Docker deployment steps
    • Usage examples (how to connect Claude to the HTTP endpoint)
    • Tool filtering examples
    • Auth setup examples
    • Troubleshooting section
  • Remove any references to standalone implementation
  • Add badge for marketplace package version

Acceptance Criteria

  • .env.example has all required and optional variables documented
  • CLAUDE.md clearly explains the wrapper architecture
  • README.md accurately describes the project as a wrapper
  • Documentation explains how to deploy with Docker
  • Examples show how to configure tool filtering and auth
  • No outdated or misleading information remains

Dependencies

Blocked by: #15 (Docker infrastructure must exist to document)

Context

Documentation is critical for understanding the corrected architecture. It must clearly explain that this is a wrapper, not a duplicate implementation.

References:

  • Corrective Rebuild specification
  • Steps 11-13 of 14-step rebuild plan

Size: M (3-4 hours)

## Summary Create documentation and configuration examples for the corrected wrapper implementation. ## Tasks ### .env.example - [ ] Create `.env.example` with all configuration options: - `GITEA_API_URL` (required) - `GITEA_API_TOKEN` (required) - `ALLOWED_TOOLS` (optional) - `DENIED_TOOLS` (optional) - `AUTH_TOKEN` (optional) - `PORT` (optional) - `HOST` (optional) - [ ] Add inline comments explaining each variable - [ ] Include example values ### CLAUDE.md - [ ] Create `CLAUDE.md` for Claude Code guidance: - Project overview (deployment wrapper, not standalone) - Architecture explanation (imports from marketplace) - How to work with this codebase - Key files and their purposes - Development workflow - Docker deployment instructions - Troubleshooting guide ### README.md Rewrite - [ ] Rewrite `README.md` to reflect correct architecture: - Clear statement: "Deployment wrapper for gitea-mcp-server marketplace package" - Installation instructions - Configuration guide (environment variables) - Docker deployment steps - Usage examples (how to connect Claude to the HTTP endpoint) - Tool filtering examples - Auth setup examples - Troubleshooting section - [ ] Remove any references to standalone implementation - [ ] Add badge for marketplace package version ## Acceptance Criteria - `.env.example` has all required and optional variables documented - `CLAUDE.md` clearly explains the wrapper architecture - `README.md` accurately describes the project as a wrapper - Documentation explains how to deploy with Docker - Examples show how to configure tool filtering and auth - No outdated or misleading information remains ## Dependencies **Blocked by:** #15 (Docker infrastructure must exist to document) ## Context Documentation is critical for understanding the corrected architecture. It must clearly explain that this is a wrapper, not a duplicate implementation. **References:** - Corrective Rebuild specification - Steps 11-13 of 14-step rebuild plan **Size:** M (3-4 hours)
lmiranda added this to the Sprint 02: Corrective Rebuild milestone 2026-02-03 21:02:20 +00:00
lmiranda added the Component/DocsType/DocumentationSize/MPriority/High labels 2026-02-03 21:02:20 +00:00
lmiranda commented 2026-02-03 21:02:24 +00:00
Author
Owner
Copy Link

⚠️ Blocked By: #15

⚠️ **Blocked By:** #15
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/Docs Priority/High Size/M Type/Documentation
Milestone
No items
No Milestone Sprint 02: Corrective Rebuild
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#16
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?