Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .cspell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@ ignorePaths:
- '.git'
- '.vscode'
- 'node_modules'
- 'pnpm-lock.yaml'
1 change: 1 addition & 0 deletions .cspell/dicts/project.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,4 @@ truecolor
getrandom
CSPRNG
subsec
peaceiris
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

- [ ] Target branch is `main`
- [ ] Status checks are passing
- [ ] Documentation updated if user-visible behavior changed (`website/docs/`, `website/i18n/ja/`, `README.md`)

## Summary

Expand Down
48 changes: 48 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Deploy docs

on:
push:
tags:
- 'v*'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6

- uses: actions/setup-node@v6
with:
node-version: lts/*

- name: Enable pnpm via corepack
run: corepack enable pnpm && corepack prepare pnpm@10.28.1 --activate

- name: Install dependencies
run: pnpm install --frozen-lockfile
working-directory: website

- name: Build
run: pnpm build
working-directory: website

- uses: actions/upload-pages-artifact@v4
with:
path: website/build

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This file provides guidance to AI coding agents when working with code in this r

- When users ask questions, answer them instead of doing the work.
- When making changes to user-visible behavior (commands, output, storage, configuration),
update `docs/user-guide.md` and `README.md` accordingly.
update `website/docs/` (and `website/i18n/ja/`) and `README.md` accordingly.

### Shell Rules

Expand Down
4 changes: 2 additions & 2 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ curl -fsSL https://raw.githubusercontent.com/23prime/backlog-cli/latest/install.
irm https://raw.githubusercontent.com/23prime/backlog-cli/latest/install.ps1 | iex
```

その他のインストール方法(ソースからのビルドなど)は [ユーザーガイド](docs/user-guide.ja.md#インストール) を参照してください。
その他のインストール方法(ソースからのビルドなど)は[ドキュメント](https://23prime.github.io/backlog-cli/ja/installation)を参照してください。

## 使い方

Expand All @@ -44,7 +44,7 @@ irm https://raw.githubusercontent.com/23prime/backlog-cli/latest/install.ps1 | i
bl space
```

詳細は [ユーザーガイド](docs/user-guide.ja.md) を参照してください。
詳細は[ドキュメント](https://23prime.github.io/backlog-cli/ja/)を参照してください。

## 開発

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# backlog-cli
# Backlog CLI

An unofficial CLI tool for [Nulab's Backlog](https://backlog.com).

Expand Down Expand Up @@ -26,7 +26,7 @@ curl -fsSL https://raw.githubusercontent.com/23prime/backlog-cli/latest/install.
irm https://raw.githubusercontent.com/23prime/backlog-cli/latest/install.ps1 | iex
```

For other installation methods (building from source, etc.), see the [User Guide](docs/user-guide.md#installation).
For other installation methods (building from source, etc.), see the [Documentation](https://23prime.github.io/backlog-cli/installation).

## Usage

Expand All @@ -44,7 +44,7 @@ For other installation methods (building from source, etc.), see the [User Guide
bl space
```

See the [User Guide](docs/user-guide.md) for full documentation.
See the [Documentation](https://23prime.github.io/backlog-cli/) for full documentation.

## Development

Expand Down
Loading