Skip to content

Commit

Permalink
Add basic pages for seabird-core and seabird-proxy-plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
belak committed Apr 1, 2024
1 parent edfbbfe commit 79e605c
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 8 deletions.
3 changes: 3 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@ language = "en"
multilingual = false
src = "src"
title = "Seabird Documentation"

#[build]
#create-missing = false
15 changes: 12 additions & 3 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Introduction

To put it simply, Seabird is an overengineered chat framework. There is a broker
service, chat backends, and plugins.
To put it simply, Seabird is an overengineered chat framework. It comes with a
broker service, chat backends, and plugins. The goal is to provide a unified
interface for linking channels together and interacting with messages.

## History

Expand All @@ -11,7 +12,15 @@ today.

## What is Seabird?

These days, Seabird is a combination of [seabird-core](./seabird_core.md) (an
These days, Seabird is a combination of [seabird-core](admin/seabird-core.md) (an
RPC service acting as a broker for other components), [chat backends]() (which
act as plumbing for hooking up a chat network like Discord), and [plugins]()
(which most closely resemble the original bot functionality).

## What Should I Look At?

Looking to run a Seabird instance of your own? Check out the Administrator
Guide, probably starting with [dependencies]().

Hoping to contribute or write a plugin? Check out the Developer Guide, starting
with the [contributing]() page.
13 changes: 8 additions & 5 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# Summary

[Introduction](README.md)
[Terminology]()

# Administrator Guide

[Dependencies]()
[Dependencies](admin/dependencies.md)

- [Core Components]()
- [seabird-core]()
- [seabird-proxy-plugin]()
- [seabird-core](admin/seabird-core.md)
- [seabird-proxy-plugin](admin/seabird-proxy-plugin.md)
- [Chat Backends]()
- [seabird-discord-backend]()
- [seabird-irc-backend]()
- [seabird-minecraft-backend]()
- [Plugins]()
- [seabird-adventofcode-plugin]()
- [seabird-datadog-plugin]()
- [seabird-github-plugin]()
- [seabird-plugin-bundle]()
- [seabird-stock-plugin]()
- [seabird-url-plugin]()
Expand All @@ -26,17 +26,20 @@

# Developer Guide

[Contributing]()
[Roadmap]()

- [Local Development]()
- [Provided Libraries]()
- [Go]()
- [Python]()
- [Rust]()
- [Writing Chat Backends]()
- [Writing Plugins]()

# Advanced Topics

- [Using the protos directly]()
- [Writing Chat Backends]()

---

Expand Down
3 changes: 3 additions & 0 deletions src/admin/seabird-core.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# seabird-core

[Repository](https://github.com/seabird-chat/seabird-core)
3 changes: 3 additions & 0 deletions src/admin/seabird-proxy-plugin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# seabird-proxy-plugin

[Repository](https://github.com/seabird-chat/seabird-proxy-plugin)

0 comments on commit 79e605c

Please sign in to comment.