Merge pull request #5 from armish/claude/publish-checklist-011CUr1PZ1LxHbCQLDrqUEqR

Publishing Requirements and Setup

Author: armish

.Rbuildignore

@@ -9,3 +9,9 @@
 ^\.git$
 ^\.claude$
 ^.*\.Rcheck$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
+^cran-comments\.md$
+^IMPROVEMENT_PLAN\.md$
+^codecov\.yml$

.github/workflows/pkgdown.yaml

@@ -0,0 +1,48 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::.
+          needs: website
+
+      - name: Build site
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/github-pages-deploy-action@v4.4.1
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

.gitignore

@@ -20,4 +20,8 @@ inst/examples/*.log
 # Temporary files
 *~
 *.swp
-*.swo
+*.swo
+
+# pkgdown
+docs/
+pkgdown/

DESCRIPTION

@@ -17,7 +17,10 @@ RoxygenNote: 7.3.2
 Imports: 
     plumber,
     jsonlite
-Suggests: 
+Suggests:
     testthat (>= 3.0.0),
-    httr
+    httr,
+    knitr,
+    rmarkdown
 Config/testthat/edition: 3
+VignetteBuilder: knitr

_pkgdown.yml

@@ -0,0 +1,77 @@
+url: https://armish.github.io/plumber2mcp/
+template:
+  bootstrap: 5
+  bootswatch: flatly
+  bslib:
+    primary: "#0054AD"
+    border-radius: 0.5rem
+    btn-border-radius: 0.25rem
+
+home:
+  title: "plumber2mcp • Add MCP Support to Plumber APIs"
+  description: >
+    Transform your Plumber APIs into AI-accessible tools using the
+    Model Context Protocol (MCP)
+
+navbar:
+  structure:
+    left: [intro, reference, articles, tutorials, news]
+    right: [search, github]
+  components:
+    home: ~
+    intro:
+      text: Get Started
+      href: articles/getting-started.html
+    reference:
+      text: Reference
+      href: reference/index.html
+    articles:
+      text: Articles
+      menu:
+      - text: Getting Started
+        href: articles/getting-started.html
+    news:
+      text: News
+      href: news/index.html
+    github:
+      icon: fab fa-github fa-lg
+      href: https://github.com/armish/plumber2mcp
+      aria-label: GitHub
+
+reference:
+  - title: "Main Functions"
+    desc: "Core functions for adding MCP support to Plumber APIs"
+    contents:
+      - pr_mcp
+      - pr_mcp_http
+      - pr_mcp_stdio
+
+  - title: "Resources"
+    desc: "Functions for adding MCP resources to expose R content"
+    contents:
+      - pr_mcp_resource
+      - pr_mcp_help_resources
+
+  - title: "Prompts"
+    desc: "Functions for adding MCP prompts to guide AI interactions"
+    contents:
+      - starts_with("pr_mcp_prompt")
+
+articles:
+  - title: "Getting Started"
+    navbar: ~
+    contents:
+      - getting-started
+
+footer:
+  structure:
+    left: developed_by
+    right: built_with
+  components:
+    built_with: >
+      Built with <a href="https://pkgdown.r-lib.org/">pkgdown</a>
+      and the <a href="https://modelcontextprotocol.io/">Model Context Protocol</a>
+
+authors:
+  Bulent Arman Aksoy:
+    href: https://github.com/armish