Mycelium/tendril
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
docs/contributing-guide-and-workflow
tendril/kb/02_systems/2025-11-11--gitea-documentation-overview--note.md
Gitea Actions 5b8bf62130
All checks were successful
KB Lint / validate (push) Successful in 24s
Details
docs(kb): migrate Gitea documentation to KB system 
Migrated all Gitea documentation from docs/GITEA/ folder into the Knowledge
Base system, following KB naming conventions and frontmatter requirements.

## What Was Migrated

### Gitea Documentation Guides (6 KB entries)

1. **Gitea Basics Guide** ()
   - Core concepts and features of Gitea
   - Key differences from GitHub
   - Terminology and common workflows
   - System requirements

2. **Gitea Actions Guide** ()
   - Gitea Actions CI/CD system
   - Compatibility with GitHub Actions
   - Workflow creation and patterns
   - Troubleshooting guide

3. **LLM Guidelines for Gitea** ()
   - Terminology guidelines for LLMs
   - Documentation standards
   - Common scenarios and checklist
   - Quick reference

4. **Gitea Workflows Guide** ()
   - Common workflows (repository setup, branches, PRs, issues)
   - Best practices (branch naming, commits, PR process)
   - Integration with documentation systems
   - Troubleshooting

5. **Gitea API Reference** ()
   - API authentication and endpoints
   - Differences from GitHub API
   - Common use cases
   - MCP server integration

6. **Gitea Documentation Overview** ()
   - Overview and index of all Gitea documentation
   - Quick reference guide
   - Links to all Gitea KB entries

## KB System Compliance

✅ All files follow KB naming convention (YYYY-MM-DD--slug--type.md)
✅ All files have complete frontmatter (all 18 required fields)
✅ All files categorized in 02_systems/ (infrastructure/tooling)
✅ All files reference original documentation location
✅ KB changelog updated with migration entry
✅ KB index regenerated via script (8 files, 23 topics, 31 tags)

## Category Decision

All Gitea documentation entries were placed in **02_systems/** category
because:
- Gitea is infrastructure/tooling (not project-specific)
- Documentation covers platform usage and integration
- Guides are system-level references
- Fits KB category definition: "Infrastructure, DevOps, tooling"

## Original Documentation

Original documentation remains in  folder:
- docs/GITEA/Gitea-Basics.md
- docs/GITEA/Gitea-Actions-Guide.md
- docs/GITEA/LLM-Gitea-Guidelines.md
- docs/GITEA/Gitea-Workflows.md
- docs/GITEA/Gitea-API-Reference.md
- docs/GITEA/README.md

KB entries reference original locations for full documentation.

## Benefits

- Gitea documentation now searchable via KB index
- Integrated with KB system for LLM discovery
- Consistent with other KB entries
- Maintains reference to original documentation
- Provides comprehensive Gitea platform reference
2025-11-11 12:36:12 -07:00

134 lines
4.9 KiB
Markdown
Raw Permalink Blame History

---
title: "Gitea Documentation Overview"
date: "2025-11-11"
captured_at: "2025-11-11"
author: ["datawarrior"]
source: { kind: doc, ref: "docs/GITEA/README.md" }
source_type: personal_note
project: ["tendril"]
related_projects: ["tendril"]
topics: ["gitea", "documentation", "overview", "platform"]
tags: ["gitea", "documentation", "overview", "platform", "self-hosted", "reference"]
type: note
status: active
phase_relevance: []
routing_hint: "Gitea documentation overview and index - infrastructure/tooling documentation"
proposed_path: "kb/02_systems/"
routing_confidence: 0.95
related: ["docs/GITEA/README.md"]
summary: "Overview of Gitea documentation directory. Provides quick reference for Gitea platform basics, Actions, workflows, API, and LLM guidelines. Index to all Gitea-related documentation."
key_takeaways: []
action_candidates: []
---
# Gitea Documentation Overview
## Purpose
This directory contains documentation to help AI assistants (LLMs) understand and work with Gitea, a self-hosted Git service.
## What is Gitea?
**Gitea** is a painless, self-hosted, all-in-one software development service. It includes Git hosting, code review, team collaboration, package registry, and CI/CD. It is similar to GitHub, Bitbucket and GitLab.
**Key Reference**: [Gitea Official Documentation](https://docs.gitea.com/)
## Documentation Contents
### Core Guides
- **[Gitea-Basics.md](./Gitea-Basics.md)** - Core concepts, features, and how Gitea differs from GitHub
- **[Gitea-Actions-Guide.md](./Gitea-Actions-Guide.md)** - Gitea Actions (CI/CD) compatibility and usage
- **[Gitea-Workflows.md](./Gitea-Workflows.md)** - Common workflows and best practices
- **[Gitea-API-Reference.md](./Gitea-API-Reference.md)** - API differences and considerations
- **[LLM-Gitea-Guidelines.md](./LLM-Gitea-Guidelines.md)** - Guidelines for LLMs working with Gitea
## Quick Reference
### What is Gitea?
Gitea is a self-hosted Git service that provides:
- Git hosting and repository management
- Code review (Pull Requests and AGit workflow)
- Issue tracking and project management
- CI/CD via Gitea Actions (compatible with GitHub Actions)
- Package registry (20+ package types)
- Team collaboration tools
### Key Differences from GitHub
1. **Self-Hosted**: Gitea runs on your own infrastructure
2. **Lightweight**: Designed to be fast and resource-efficient
3. **Open Source**: MIT licensed, community-driven
4. **Actions Compatibility**: Gitea Actions uses the same YAML format as GitHub Actions
5. **API Compatibility**: Gitea API is similar to GitHub's but has some differences
### Gitea Actions Compatibility
**Critical**: Gitea Actions is compatible with GitHub Actions:
- Same `.github/workflows/` directory structure
- Same YAML workflow format
- Same triggers and syntax
- Existing GitHub Actions workflows work with minimal or no modifications
- Actions plugins can be downloaded from any Git website
**Reference**: [Gitea Actions Documentation](https://docs.gitea.com/usage/actions/)
## For LLMs Working with Gitea
### Terminology
- Use **"Gitea"** (not "GitHub") when referring to the platform
- Use **"Gitea Actions"** (not "GitHub Actions") but note compatibility
- Use **"Pull Request"** or **"PR"** (same as GitHub)
- Use **"Issues"** (same as GitHub)
- Use **"Repository"** or **"Repo"** (same as GitHub)
### Documentation References
When creating documentation:
- Reference Gitea-specific features when relevant
- Note GitHub Actions compatibility when discussing workflows
- Use Gitea terminology consistently
- Link to Gitea documentation: `https://docs.gitea.com/`
### Workflow Files
- Workflows use `.github/workflows/` directory (same as GitHub)
- YAML format is identical to GitHub Actions
- Reference as "Gitea Actions workflows" in documentation
- Note compatibility: "Gitea Actions is compatible with GitHub Actions"
## Repository Context
**Tendril Repository**: https://git.parkingmeter.info/Mycelium/tendril
**Gitea Instance**: Self-hosted at git.parkingmeter.info
**Primary Platform**: Gitea (not GitHub)
## Additional Resources
- **Official Gitea Docs**: https://docs.gitea.com/
- **Gitea Actions**: https://docs.gitea.com/usage/actions/
- **Gitea API**: https://docs.gitea.com/api/
- **Gitea Source**: https://gitea.com/gitea/gitea
## KB Entries
All Gitea documentation has been migrated to KB system:
- `kb/02_systems/2025-11-11--gitea-basics-guide--howto.md` - Gitea basics
- `kb/02_systems/2025-11-11--gitea-actions-guide--howto.md` - Gitea Actions
- `kb/02_systems/2025-11-11--gitea-llm-guidelines--howto.md` - LLM guidelines
- `kb/02_systems/2025-11-11--gitea-workflows-guide--howto.md` - Workflows
- `kb/02_systems/2025-11-11--gitea-api-reference--howto.md` - API reference
- `kb/02_systems/2025-11-11--gitea-documentation-overview--note.md` - This overview
---
**Original Location**: `docs/GITEA/README.md`
**Last Updated**: 2025-01-27
**Related**:
- All Gitea documentation files in `docs/GITEA/`
- All Gitea KB entries in `kb/02_systems/`
Reference in New Issue View Git Blame Copy Permalink