Skip to content

fix(docs): #2 wiki/Home.md — landing page for GitHub Wiki mirror#26

Merged
hanwencheng merged 1 commit into
mainfrom
fix/issue-2
Apr 14, 2026
Merged

fix(docs): #2 wiki/Home.md — landing page for GitHub Wiki mirror#26
hanwencheng merged 1 commit into
mainfrom
fix/issue-2

Conversation

@hanwencheng
Copy link
Copy Markdown
Member

@hanwencheng hanwencheng commented Apr 14, 2026

Summary

Adds wiki/Home.md — the landing page for the GitHub Wiki — and documents the companion CI workflow that must be added manually (the OAuth token used for this PR cannot push .github/workflows/*).

What changed

  • wiki/Home.md — landing page with an "edit the source, not the web UI" banner + index of the 6 existing wiki pages.

What a maintainer must add manually

The CI workflow file .github/workflows/publish-wiki.yml could not be pushed from this session (OAuth token lacks the workflow scope — a standard GitHub restriction for safety). A maintainer should add this file in a follow-up commit (via the GitHub web editor, or locally with a PAT that has the workflow scope):

name: Publish wiki

# One-way mirror: wiki/ in this repo is the canonical source for the GitHub Wiki.
# Every push to main that touches wiki/ copies the folder over to
# litentry/agentKeys.wiki.git.
#
# Edits made directly through the GitHub Wiki web UI will be overwritten on the
# next push to main that touches wiki/. See wiki/Home.md for the developer note.

on:
  push:
    branches: [main]
    paths:
      - 'wiki/**'
  workflow_dispatch:

jobs:
  publish:
    runs-on: ubuntu-latest
    concurrency:
      group: wiki-publish
      cancel-in-progress: false
    permissions:
      contents: write
    steps:
      - name: Checkout main repo
        uses: actions/checkout@v4

      - name: Publish to wiki
        uses: Andrew-Chen-Wang/github-wiki-action@v4
        with:
          path: wiki/

Prerequisite (manual)

GitHub doesn't create litentry/agentKeys.wiki.git until at least one wiki page has been saved through the web UI. Before the workflow can run:

  1. Visit https://github.com/litentry/agentKeys/wiki, click "Create the first page", save anything.
  2. Merge the workflow file (above).
  3. The next push that touches wiki/** will trigger the mirror.

Test plan

  • wiki/Home.md renders cleanly in a markdown preview.
  • After workflow is merged and the wiki repo is initialized: push a trivial wiki/ change and confirm the action runs.
  • Confirm paths: ['wiki/**'] filter means non-wiki commits don't trigger the workflow.

Issue

Closes #2 (documentation + initial Home.md). Workflow file tracked as "add by maintainer" in the PR body.

🤖 Generated with Claude Code

  • Codex reviewer: approved (no actionable findings — merged before codex tracking added)

Partial fix for #2. The workflow file itself (.github/workflows/publish-wiki.yml)
cannot be pushed from this OAuth session (token lacks the 'workflow' scope).
The full workflow YAML is included in the PR body for a maintainer to add
manually via the GitHub web UI or a PAT with workflow scope.

Adds wiki/Home.md — the landing page. Once the workflow is in place, every
push to main that touches wiki/** will mirror to litentry/agentKeys.wiki.git.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@hanwencheng hanwencheng merged commit 17213b7 into main Apr 14, 2026
hanwencheng added a commit that referenced this pull request Apr 14, 2026
docs(wiki): note workflow_dispatch for manual mirror — tests PR #26 pipeline
@hanwencheng
Copy link
Copy Markdown
Member Author

Codex review (via gstack /codex skill, GPT-5.4 codex-high reasoning against origin/main)

Verdict

PR merged before review ran. HEAD of fix/issue-2 is an ancestor of origin/main (PR #26 already landed on main via merge commit 17213b7). codex review --base main correctly reported no patch to analyze. No actionable findings.

— codex review --base main

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: mirror wiki/ folder to GitHub Wiki via CI

1 participant