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
Member

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
docs: add README.md and AGENTS.md
All checks were successful
check-commitizen.yaml / Check the PR title (pull_request) Successful in 2s
check-yamllint.yaml / Lint yaml files (pull_request) Successful in 2s
check-formatter.yaml / Checks with formatters (pull_request) Successful in 9s
check-linter.yaml / Checks with linters (pull_request) Successful in 12s
check-syntax.yaml / Checks with static tools (pull_request) Successful in 19s
llm-bot / LLM Bot response generation (pull_request) Successful in 3s
91aa9715f2
Merge branch 'main' into docs/readme-agents-md
All checks were successful
check-yamllint.yaml / Lint yaml files (pull_request) Successful in 2s
check-formatter.yaml / Checks with formatters (pull_request) Successful in 8s
check-linter.yaml / Checks with linters (pull_request) Successful in 11s
check-syntax.yaml / Checks with static tools (pull_request) Successful in 18s
1732ff6d4f
Merge branch 'main' into docs/readme-agents-md
All checks were successful
check-yamllint.yaml / Lint yaml files (pull_request) Successful in 2s
check-formatter.yaml / Checks with formatters (pull_request) Successful in 9s
check-linter.yaml / Checks with linters (pull_request) Successful in 11s
check-syntax.yaml / Checks with static tools (pull_request) Successful in 17s
8352d9230f
Merge branch 'main' into docs/readme-agents-md
All checks were successful
check-yamllint.yaml / Lint yaml files (pull_request) Successful in 3s
check-formatter.yaml / Checks with formatters (pull_request) Successful in 8s
check-linter.yaml / Checks with linters (pull_request) Successful in 11s
check-syntax.yaml / Checks with static tools (pull_request) Successful in 17s
caf313c0f4
Owner

@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?
docs: update README and AGENTS for forgejo/ refactor and git.ts
All checks were successful
check-formatter.yaml / Checks with formatters (pull_request) Successful in 9s
check-linter.yaml / Checks with linters (pull_request) Successful in 10s
check-syntax.yaml / Checks with static tools (pull_request) Successful in 17s
check-yamllint.yaml / Lint yaml files (pull_request) Successful in 2s
42b28a3901
Author
Member

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.
docs: improve and add license
Some checks failed
check-prettier.yaml / Check files formatting (pull_request) Failing after 1s
check-yamllint.yaml / Lint yaml files (pull_request) Successful in 2s
check-formatter.yaml / Checks with formatters (pull_request) Successful in 8s
check-linter.yaml / Checks with linters (pull_request) Successful in 10s
check-syntax.yaml / Checks with static tools (pull_request) Successful in 17s
367128f885
chore: format files
Some checks failed
check-prettier.yaml / Check files formatting (pull_request) Failing after 1s
check-yamllint.yaml / Lint yaml files (pull_request) Successful in 2s
check-formatter.yaml / Checks with formatters (pull_request) Successful in 8s
check-linter.yaml / Checks with linters (pull_request) Successful in 11s
check-syntax.yaml / Checks with static tools (pull_request) Successful in 17s
22994d2146
chore: update image
All checks were successful
check-prettier.yaml / Check files formatting (pull_request) Successful in 6s
check-formatter.yaml / Checks with formatters (pull_request) Successful in 8s
check-yamllint.yaml / Lint yaml files (pull_request) Successful in 2s
check-linter.yaml / Checks with linters (pull_request) Successful in 11s
check-syntax.yaml / Checks with static tools (pull_request) Successful in 17s
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
Sign in to join this conversation.
No reviewers
No labels
No milestone
No assignees
2 participants
Notifications
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.