Skip to content

Commit 4458f99

Browse files
authored
Merge pull request #52 from nj-io/develop
chore: merge develop into main
2 parents 9ca043e + a968d08 commit 4458f99

30 files changed

Lines changed: 9 additions & 9 deletions

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ on:
44
push:
55
branches: [main]
66
paths:
7-
- "docs/**"
7+
- "site-docs/**"
88
- "mkdocs.yml"
99
- "scripts/generate_cli_docs.py"
1010
- "src/social_hook/cli/**"

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ site_description: Automated social media content from development activity
33
site_url: https://nj-io.github.io/social-hook/docs/
44
repo_url: https://github.com/nj-io/social-hook
55
repo_name: nj-io/social-hook
6-
edit_uri: edit/main/docs/
6+
edit_uri: edit/main/site-docs/
77

8-
docs_dir: docs
8+
docs_dir: site-docs
99
site_dir: site
1010

1111
theme:

scripts/generate_cli_docs.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
#!/usr/bin/env python3
22
"""Generate CLI reference documentation from the Typer app.
33
4-
Introspects the Click command tree and writes markdown files to docs/cli/.
4+
Introspects the Click command tree and writes markdown files to site-docs/cli/.
55
Run from repo root: python scripts/generate_cli_docs.py
66
77
Output structure:
8-
docs/cli/index.md — overview with global options and command list
9-
docs/cli/<group>.md — one page per command group (draft, project, etc.)
10-
docs/cli/root-commands.md — top-level commands (version, init, trigger, etc.)
8+
site-docs/cli/index.md — overview with global options and command list
9+
site-docs/cli/<group>.md — one page per command group (draft, project, etc.)
10+
site-docs/cli/root-commands.md — top-level commands (version, init, trigger, etc.)
1111
"""
1212

1313
from __future__ import annotations
@@ -25,7 +25,7 @@
2525
from social_hook.cli import app
2626
from social_hook.constants import PROJECT_SLUG
2727

28-
DOCS_DIR = Path(__file__).resolve().parent.parent / "docs" / "cli"
28+
DOCS_DIR = Path(__file__).resolve().parent.parent / "site-docs" / "cli"
2929

3030
# Commands to exclude from docs (internal hooks)
3131
HIDDEN_COMMANDS = {"commit-hook", "git-hook", "narrative-capture"}
@@ -271,7 +271,7 @@ def main() -> None:
271271
index_path.write_text(index_page)
272272
print(f" wrote {index_path.relative_to(DOCS_DIR.parent.parent)}")
273273

274-
print(f"\nGenerated {len(groups) + 2} files in docs/cli/")
274+
print(f"\nGenerated {len(groups) + 2} files in site-docs/cli/")
275275

276276

277277
if __name__ == "__main__":
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)