Skip to content

Commit 714d1e8

Browse files
committed
feat(docs): add forge, prompts, tools, and settings documentation
Add setup guides for GitHub and GitLab forge integration, custom prompts documentation, tools configuration guide, and settings reference. Add design document for custom prompts and tools RFC. Add webhook testing and configuration validation scripts. Update README with forge integration features and configuration sections. Signed-off-by: derekbarbosa <derekasobrab@gmail.com>
1 parent cbba8a6 commit 714d1e8

16 files changed

Lines changed: 2223 additions & 41 deletions

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,11 @@ Please, note that as with any other LLM-based tools, Sashiko's output is probabi
1919

2020
## Features
2121

22-
- **Automated Ingestion**: Monitors mailing lists (using `lore.kernel.org`) for new patch submissions.
23-
- **Manual Ingestion**: Can ingest patches from a local git repository.
24-
- **Self-contained**: Doesn't depend on 3rd-party tools and can work with various LLM providers (Gemini and Claude are currently supported).
25-
- **Web interface and CLI**: Provides a web interface and a CLI tool. Email support will be added soon.
22+
- **Automated Ingestion**: Monitors mailing lists (`lore.kernel.org`), GitHub PRs, and GitLab MRs for new patch submissions.
23+
- **Manual Ingestion**: Can ingest patches from local git repositories or specific PRs/MRs.
24+
- **Forge Integration**: Automatic PR/MR review via GitHub and GitLab webhooks.
25+
- **Self-contained**: Doesn't depend on 3rd-party tools and works with multiple LLM providers (Gemini and Claude currently supported).
26+
- **Web interface and CLI**: Provides a web interface for monitoring and a CLI tool for local development.
2627

2728
## Prompts
2829

@@ -90,6 +91,10 @@ cargo install sashiko
9091
* **Server**: API server host and port.
9192
* **Git**: Path to the reference kernel repository.
9293
* **Review**: Concurrency and worktree settings.
94+
* **Tools**: Configure which AI tools are enabled (optional). See [docs/TOOLS.md](docs/TOOLS.md) for details.
95+
* **Forge**: GitHub/GitLab webhook integration (optional). See forge setup guides below.
96+
* **Prompts**: Customize review stages and prompts (optional). See [docs/PROMPTS.md](docs/PROMPTS.md) for details.
97+
* **Subsystems**: Map file patterns to subsystems for targeted reviews (optional).
9398

9499
### Configuring the LLM Provider
95100

0 commit comments

Comments
 (0)