Skip to content

Commit f1fc993

Browse files
SchmidtPaulclaude
andcommitted
Add documentation, CI, pkgdown site, and pre-release fixes
- Add README with workflow diagram and Claude Code integration section - Add getting-started vignette (plain markdown code blocks) - Add pkgdown config with BioMath branding and extra.css - Add GitHub Actions: R-CMD-check (ubuntu/macOS/windows) and pkgdown deploy - Add NEWS.md with initial changelog - Add SKILL.md for Claude Code skill integration - Fix copyright holder (Paul Schmidt, not BioMath GmbH) - Add DESCRIPTION URLs (GitHub repo, pkgdown site, BugReports) - Add Claude Code + btw reference to package description - Improve code comments in extract_tracked_changes.R and utils.R - Preserve document order for tracked changes via combined XPath - Remove CLAUDE.md from git tracking (stays local via .gitignore) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent f0ad508 commit f1fc993

19 files changed

Lines changed: 532 additions & 171 deletions

.Rbuildignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
^LICENSE\.md$
22
^\.claude$
33
^CLAUDE\.md$
4+
^_pkgdown\.yml$
5+
^pkgdown$
6+
^\.github$
7+
^README\.md$

.github/workflows/R-CMD-check.yaml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
3+
on:
4+
push:
5+
branches: [main, master]
6+
pull_request:
7+
branches: [main, master]
8+
9+
name: R-CMD-check
10+
11+
permissions: read-all
12+
13+
jobs:
14+
R-CMD-check:
15+
runs-on: ${{ matrix.config.os }}
16+
17+
name: ${{ matrix.config.os }} (${{ matrix.config.r }})
18+
19+
strategy:
20+
fail-fast: false
21+
matrix:
22+
config:
23+
- {os: macos-latest, r: 'release'}
24+
- {os: windows-latest, r: 'release'}
25+
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
26+
- {os: ubuntu-latest, r: 'release'}
27+
- {os: ubuntu-latest, r: 'oldrel-1'}
28+
29+
env:
30+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
31+
R_KEEP_PKG_SOURCE: yes
32+
33+
steps:
34+
- uses: actions/checkout@v4
35+
36+
- uses: r-lib/actions/setup-pandoc@v2
37+
38+
- uses: r-lib/actions/setup-r@v2
39+
with:
40+
r-version: ${{ matrix.config.r }}
41+
http-user-agent: ${{ matrix.config.http-user-agent }}
42+
use-public-rspm: true
43+
44+
- uses: r-lib/actions/setup-r-dependencies@v2
45+
with:
46+
extra-packages: any::rcmdcheck
47+
needs: check
48+
49+
- uses: r-lib/actions/check-r-package@v2
50+
with:
51+
upload-snapshots: true
52+
build_args: 'c("--no-manual","--compact-vignettes=gs+qpdf")'

.github/workflows/pkgdown.yaml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
2+
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
3+
on:
4+
push:
5+
branches: [main, master]
6+
pull_request:
7+
branches: [main, master]
8+
release:
9+
types: [published]
10+
workflow_dispatch:
11+
12+
name: pkgdown
13+
14+
permissions: read-all
15+
16+
jobs:
17+
pkgdown:
18+
runs-on: ubuntu-latest
19+
# Only restrict concurrency for non-PR jobs
20+
concurrency:
21+
group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
22+
env:
23+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
24+
permissions:
25+
contents: write
26+
steps:
27+
- uses: actions/checkout@v4
28+
29+
- uses: r-lib/actions/setup-pandoc@v2
30+
31+
- uses: r-lib/actions/setup-r@v2
32+
with:
33+
use-public-rspm: true
34+
35+
- uses: r-lib/actions/setup-r-dependencies@v2
36+
with:
37+
extra-packages: any::pkgdown, local::.
38+
needs: website
39+
40+
- name: Build site
41+
run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
42+
shell: Rscript {0}
43+
44+
- name: Deploy to GitHub pages 🚀
45+
if: github.event_name != 'pull_request'
46+
uses: JamesIves/github-pages-deploy-action@v4.7.3
47+
with:
48+
clean: false
49+
branch: gh-pages
50+
folder: docs

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
.claude
22
.claude/**
3+
CLAUDE.md
4+
inst/doc

CLAUDE.md

Lines changed: 0 additions & 147 deletions
This file was deleted.

DESCRIPTION

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,18 @@ Description: Extract comments and tracked changes from reviewed Word
88
documents (.docx) and return them as structured data or formatted
99
Markdown. Designed for workflows where documents are rendered from
1010
Quarto or R Markdown, reviewed in Microsoft Word, and feedback needs
11-
to be processed programmatically.
11+
to be processed programmatically — particularly with Claude Code
12+
and btw for AI-assisted review processing.
1213
License: MIT + file LICENSE
14+
URL: https://github.com/SchmidtPaul/docxreview,
15+
https://schmidtpaul.github.io/docxreview/
16+
BugReports: https://github.com/SchmidtPaul/docxreview/issues
1317
Encoding: UTF-8
1418
Roxygen: list(markdown = TRUE)
1519
RoxygenNote: 7.3.3
1620
Suggests:
21+
knitr,
22+
rmarkdown,
1723
testthat (>= 3.0.0),
1824
withr
1925
Config/testthat/edition: 3
@@ -22,3 +28,4 @@ Imports:
2228
officer,
2329
tibble,
2430
xml2
31+
VignetteBuilder: knitr

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
YEAR: 2026
2-
COPYRIGHT HOLDER: BioMath GmbH
2+
COPYRIGHT HOLDER: Paul Schmidt

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MIT License
22

3-
Copyright (c) 2026 BioMath GmbH
3+
Copyright (c) 2026 Paul Schmidt
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

NEWS.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# docxreview 0.0.0.9000
2+
3+
* Initial development version.
4+
* Added `extract_comments()` to extract comments with paragraph context.
5+
* Added `extract_tracked_changes()` to extract insertions and deletions with paragraph context.
6+
* Added `extract_review()` to combine both into formatted Markdown output.

R/extract_comments.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ extract_comments <- function(docx_path) {
3131
return(empty_comments_tibble())
3232
}
3333

34-
# Get the document XML for paragraph context
35-
34+
# Access the internal officer XML object for paragraph-level context
35+
# (no public API for this — doc_obj$get() returns the body XML tree)
3636
doc_xml <- doc$doc_obj$get()
3737

3838
# For each comment, find the paragraph(s) containing the comment range

0 commit comments

Comments
 (0)