docs: add README.md and AGENTS.md #49

Merged

davide merged 8 commits from docs/readme-agents-md into main 2026-06-20 14:20:11 +00:00

Conversation 2 Commits 8 Files changed 6 +222 -1

Ghost commented 2026-06-19 12:55:16 +00:00

• Copy link
• Copy Markdown

Summary

Adds README.md and AGENTS.md to the repository as requested.

README.md

• Project overview and description
• Quick start guide with usage example
• Inputs documentation
• Build instructions
• Project structure

AGENTS.md

• Tech stack and conventions
• Build & development commands
• Architecture overview with file descriptions
• Event handling table
• CI/CD and conventions

## Summary Adds `README.md` and `AGENTS.md` to the repository as requested. ### README.md - Project overview and description - Quick start guide with usage example - Inputs documentation - Build instructions - Project structure ### AGENTS.md - Tech stack and conventions - Build & development commands - Architecture overview with file descriptions - Event handling table - CI/CD and conventions

Ghost added 1 commit 2026-06-19 12:55:16 +00:00

docs: add README.md and AGENTS.md 91aa9715f2

Ghost referenced this pull request 2026-06-19 12:56:30 +00:00

README.md and AGENTS.md are not present #48

Ghost referenced this pull request 2026-06-19 12:57:39 +00:00

README.md and AGENTS.md are not present #48

davide added 1 commit 2026-06-19 15:18:49 +00:00

Merge branch 'main' into docs/readme-agents-md 1732ff6d4f

davide added 1 commit 2026-06-20 12:28:32 +00:00

Merge branch 'main' into docs/readme-agents-md 8352d9230f

davide added 1 commit 2026-06-20 13:19:45 +00:00

Merge branch 'main' into docs/readme-agents-md caf313c0f4

davide commented 2026-06-20 13:47:01 +00:00

Owner

• Copy link
• Copy Markdown

@llm-bot I changed the structure and working of the agent a bit, now src/forgejo.ts has been split and cloning is done inside the program (src/git.ts and src/main.ts) can you check if readme and agents need to be updated?

@llm-bot I changed the structure and working of the agent a bit, now src/forgejo.ts has been split and cloning is done inside the program (src/git.ts and src/main.ts) can you check if readme and agents need to be updated?

Ghost added 1 commit 2026-06-20 13:58:07 +00:00

docs: update README and AGENTS for forgejo/ refactor and git.ts 42b28a3901

Ghost commented 2026-06-20 13:59:07 +00:00

• Copy link
• Copy Markdown

Good call — I've updated both files to reflect the recent structural changes:

README.md:

• Updated Project Structure to show src/forgejo/ as a directory with fetch.ts and index.ts, and added the new src/git.ts

AGENTS.md:

• Updated Architecture section to:
  • Add step 2: Git Checkout (src/git.ts) for cloning/checkout
  • Update step 4: Forgejo Client now references src/forgejo/ with its two files
  • Renumbered subsequent steps and updated step 6 (Entry Point) to mention the repository cloning

The docs now accurately reflect the current codebase layout.

Good call — I've updated both files to reflect the recent structural changes: **README.md:** - Updated **Project Structure** to show `src/forgejo/` as a directory with `fetch.ts` and `index.ts`, and added the new `src/git.ts` **AGENTS.md:** - Updated **Architecture** section to: - Add step 2: **Git Checkout** (`src/git.ts`) for cloning/checkout - Update step 4: **Forgejo Client** now references `src/forgejo/` with its two files - Renumbered subsequent steps and updated step 6 (Entry Point) to mention the repository cloning The docs now accurately reflect the current codebase layout.

davide added 1 commit 2026-06-20 14:14:48 +00:00

docs: improve and add license 367128f885

davide added 1 commit 2026-06-20 14:15:43 +00:00

chore: format files 22994d2146

davide added 1 commit 2026-06-20 14:17:24 +00:00

chore: update image 9c28cca258

davide merged commit 1bfae99991 into main 2026-06-20 14:20:11 +00:00

davide deleted branch docs/readme-agents-md 2026-06-20 14:20:11 +00:00

davide referenced this pull request from a commit 2026-06-20 14:20:12 +00:00

docs: add README.md and AGENTS.md (#49)

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels

  

Compat/Breaking

Breaking change that won't be backward compatible

  

Kind/Bug

Something is not working

  

Kind/Documentation

Documentation changes

  

Kind/Enhancement

Improve existing functionality

  

Kind/Feature

New functionality

  

Kind/Security

This is security issue

  

Kind/Testing

Issue or pull request related to testing

  

Priority

Critical

The priority is critical

  

Priority

High

The priority is high

  

Priority

Low

The priority is low

  

Priority

Medium

The priority is medium

  

Reviewed

Confirmed

Issue has been confirmed

  

Reviewed

Duplicate

This issue or pull request already exists

  

Reviewed

Invalid

Invalid issue

  

Reviewed

Won't Fix

This issue won't be fixed

  

Status

Abandoned

Somebody has started to work on this but abandoned work

  

Status

Blocked

Something is blocking this issue or pull request

  

Status

Need More Info

Feedback is required to reproduce issue or to continue work

No labels

Compat/Breaking

Kind/Bug

Kind/Documentation

Kind/Enhancement

Kind/Feature

Kind/Security

Kind/Testing

Priority

Critical

Priority

High

Priority

Low

Priority

Medium

Reviewed

Confirmed

Reviewed

Duplicate

Reviewed

Invalid

Reviewed

Won't Fix

Status

Abandoned

Status

Blocked

Status

Need More Info

Milestone

Clear milestone

No items

No milestone

Assignees

Clear assignees

No assignees

2 participants

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

projects/forgejo-agent!49

No description provided.