Skip to content

Commit 83c9a2f

Browse files
committed
Merge build and deploy into one job
1 parent 6dd4886 commit 83c9a2f

File tree

5 files changed

+41
-37
lines changed

5 files changed

+41
-37
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ env:
2222
jobs:
2323
build-and-deploy:
2424
runs-on: ubuntu-latest
25-
concurrency: ci-${{ github.ref }}
25+
concurrency: docs-${{ github.ref }}
2626
environment:
2727
name: github-pages
2828
url: ${{ steps.deployment.outputs.page_url }}

CLAUDE.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
44

55
## Project Overview
66

7-
Tanka Documentation Generator is a .NET 9.0 console application that generates static HTML documentation sites from Markdown files. It's packaged as a .NET Global Tool (`Tanka.DocsGen`) and provides advanced features like live C# code integration via Roslyn and multi-source content aggregation.
7+
Tanka Documentation Generator is a .NET 9.0 console application that generates static HTML documentation sites from Markdown files. It's distributed as a .NET Global Tool (`Tanka.DocsGen`) that can be installed via `dotnet tool install --global Tanka.DocsGen`. It provides advanced features like live C# code integration via Roslyn and multi-source content aggregation.
88

99
## Common Development Commands
1010

@@ -32,12 +32,13 @@ dotnet run --project ./src/DocsTool/ -- dev -f ./tanka-docs-wip.yml
3232
dotnet run --project ./src/DocsTool/ -- build -f ./tanka-docs-wip.yml
3333
```
3434

35-
### Tool Development and Testing
35+
### Tool Installation and Testing
3636
```bash
37-
# Build and pack the global tool
38-
dotnet pack -c Release -o ./artifacts
37+
# Install from NuGet (primary method)
38+
dotnet tool install --global Tanka.DocsGen
3939

40-
# Install tool locally for testing
40+
# Or build and pack the global tool locally for development
41+
dotnet pack -c Release -o ./artifacts
4142
dotnet tool install --global --add-source ./artifacts Tanka.DocsGen
4243

4344
# Test the installed tool

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,15 @@ Tanka Docs is a powerful technical documentation generator designed for .NET pro
1818

1919
### 1. Install
2020

21-
**Note:** Tanka.DocsGen is currently distributed as source code. To install:
21+
Install Tanka Docs as a .NET global tool:
2222

2323
```bash
24-
# Clone the repository
24+
# Install from NuGet (recommended)
25+
dotnet tool install --global Tanka.DocsGen
26+
27+
# Or install from local source (for development)
2528
git clone https://github.com/pekkah/tanka-docs-gen.git
2629
cd tanka-docs-gen
27-
28-
# Build the tool
29-
dotnet build
30-
31-
# Install as global tool (optional)
3230
dotnet pack -c Release -o ./artifacts
3331
dotnet tool install --global --add-source ./artifacts Tanka.DocsGen
3432
```

docs-v2/01-getting-started/getting-started.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,26 @@ This guide will walk you through setting up your first Tanka Docs project from s
1212
- **Git** (Tanka Docs sources content from Git repositories)
1313
- **Text editor** or IDE of your choice
1414

15-
## Step 1: Clone the Project
15+
## Step 1: Install Tanka Docs
1616

17-
Tanka Docs is currently distributed as source code. Clone the repository:
17+
Install Tanka Docs as a .NET global tool:
1818

1919
```bash
20-
git clone https://github.com/pekkah/tanka-docs-gen.git
21-
cd tanka-docs-gen
20+
# Install from NuGet (recommended)
21+
dotnet tool install --global Tanka.DocsGen
2222
```
2323

24-
## Step 2: Build the Tool
25-
26-
Build the Tanka Docs tool:
24+
**Alternative installation from source:**
2725

2826
```bash
29-
dotnet build
27+
# Clone and build from source (for development)
28+
git clone https://github.com/pekkah/tanka-docs-gen.git
29+
cd tanka-docs-gen
30+
dotnet pack -c Release -o ./artifacts
31+
dotnet tool install --global --add-source ./artifacts Tanka.DocsGen
3032
```
3133

32-
## Step 3: Create Your Documentation Project
34+
## Step 2: Create Your Documentation Project
3335

3436
Create a new directory for your documentation project:
3537

@@ -39,7 +41,7 @@ cd my-docs-project
3941
git init -b main
4042
```
4143

42-
## Step 4: Create the Main Configuration File
44+
## Step 3: Create the Main Configuration File
4345

4446
Create `tanka-docs.yml` in your project root. This file defines your site structure and content sources:
4547

@@ -66,7 +68,7 @@ branches:
6668
- `branches`: Git branches/refs to source content from
6769
- `input_path`: Directories to include from each branch
6870

69-
## Step 5: Create Documentation Sections
71+
## Step 4: Create Documentation Sections
7072

7173
Tanka Docs organizes content into sections. Create your main documentation section:
7274

@@ -94,7 +96,7 @@ includes:
9496
- `nav`: Navigation file(s) for this section
9597
- `includes`: File patterns to include in this section
9698

97-
## Step 6: Create Content Files
99+
## Step 5: Create Content Files
98100

99101
### Main Index Page
100102

@@ -177,7 +179,7 @@ your-command --version
177179
178180
Create additional pages (`docs/configuration.md`, `docs/advanced.md`) following the same pattern.
179181
180-
## Step 7: Add Shared Content (Optional)
182+
## Step 6: Add Shared Content (Optional)
181183
182184
Create a partials section for shared content:
183185

docs-v2/04-advanced/cli-reference.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,32 @@ Tanka Docs provides a command-line interface (CLI) that allows you to build and
88

99
## Installation
1010

11-
**Note:** Tanka.DocsGen is currently distributed as source code. To install:
11+
Install Tanka Docs as a .NET global tool:
1212

1313
```bash
14-
# Clone the repository
15-
git clone https://github.com/pekkah/tanka-docs-gen.git
16-
cd tanka-docs-gen
14+
# Install from NuGet (recommended)
15+
dotnet tool install --global Tanka.DocsGen
16+
```
1717

18-
# Build the tool
19-
dotnet build
18+
**Alternative installation from source (for development):**
2019

21-
# Install as global tool (optional)
20+
```bash
21+
# Clone and build from source
22+
git clone https://github.com/pekkah/tanka-docs-gen.git
23+
cd tanka-docs-gen
2224
dotnet pack -c Release -o ./artifacts
2325
dotnet tool install --global --add-source ./artifacts Tanka.DocsGen
2426
```
2527

2628
To update to the latest version:
2729

2830
```bash
29-
# Pull latest changes and rebuild
30-
git pull
31-
dotnet build
31+
# Update from NuGet
32+
dotnet tool update --global Tanka.DocsGen
3233

33-
# Update global tool (if installed)
34+
# Or update from source (if installed from source)
35+
git pull
36+
dotnet pack -c Release -o ./artifacts
3437
dotnet tool update --global --add-source ./artifacts Tanka.DocsGen
3538
```
3639

0 commit comments

Comments
 (0)