Перейти к содержимому

Об этом сайте

Этот сайт — справочник для авторов плагинов bb: чем может владеть плагин, где работает каждая точка входа, как устроена поверхность API и что на самом деле гарантирует модель доверия. Здесь — на какой версии bb основан сайт, как он собирается и под какой лицензией распространяется.

Сайт описывает выпущенный релиз: bb 0.43.3, @get-bb/plugin-sdk 0.4.104, тег desktop-v0.43.3. На сгенерированных страницах указана эта версия, а каждая ссылка на символ ведёт на закреплённый коммит.

Всё, что есть в main, но не вошло в 0.43.3, не выдаётся за доступное, а получает пометку «unreleased: lands after 0.43.3». В тексте остаются все оговорки: если при исследовании кода не удалось что-то подтвердить, прямо написано не проверено, и это остаётся на виду.

Справочные разделы (поверхности, неймспейсы бэкенда, слоты фронтенда, каталог плагинов, changelog) генерируются из репозитория upstream на закреплённом коммите. Результат коммитится как данные, поэтому релиз upstream приходит в виде диффа, пригодного для ревью. Остальной текст написан вручную. Идентификаторы, пути, команды CLI, id плагинов и строки интерфейса bb выглядят ровно так, как в upstream, и никогда не переводятся.

Сайт собирается из github.com/nobilix/bb-plugin-atlas. Присылайте ишью и пулл-реквесты. В CONTRIBUTING.md описано, что генерируется, что пишется вручную и как запускать проверки.

Сайт и его инструменты распространяются под лицензией MIT. Сам bb — отдельный проект: его код, названия и строки интерфейса принадлежат ему.