Skip to content

docs: add PO guide for editing site content - #221

Open
skelz0r wants to merge 1 commit into
developfrom
docs/po-content-editing-guide
Open

docs: add PO guide for editing site content#221
skelz0r wants to merge 1 commit into
developfrom
docs/po-content-editing-guide

Conversation

@skelz0r

@skelz0r skelz0r commented Jun 25, 2026

Copy link
Copy Markdown
Member

Add a step-by-step guide in docs/ aimed at non-technical product owners so they can autonomously make small content changes (endpoint fiches, FAQ, wording, fixes) and open a pull request.

Covers, with a verify-first pattern at each install step (and install instructions only when missing): terminal basics, Homebrew, git identity with DCO sign-off, mandatory GPG commit signing plus secure key backup, GitHub auth and repo clone via gh, optional Docker site preview, agent-vm, and the remote Linear MCP server for both Claude and Codex.

Editing happens through the agent inside agent-vm (repo is shared, so no git/SSH/GPG config is needed in the VM); commit, sign and PR happen on the host, either via the terminal or GitHub Desktop. Includes prominent security disclaimers (no API keys, secrets or personal data) and a troubleshooting section.

@skelz0r skelz0r self-assigned this Jun 25, 2026
Add a step-by-step guide in docs/ aimed at non-technical product owners so
they can autonomously make small content changes (endpoint fiches, FAQ,
wording, fixes) and open a pull request.

Covers, with a verify-first pattern at each install step (and install
instructions only when missing): terminal basics, the platform package
manager, git identity, mandatory GPG commit signing plus secure personal key
backup, GitHub Desktop for auth/clone, optional Docker site preview, agent-vm,
and an optional one-paste setup of the remote Linear MCP server for both
Claude and Codex.

The guide is cross-platform: a common workflow with install steps forked per
OS (macOS via Homebrew/Lima, Windows via winget/WSL2 + agent-vm-windows).
Editing happens through the agent inside agent-vm (repo is shared, so no
git/SSH/GPG config is needed in the VM). All git operations (branch, commit
with manual DCO sign-off, push, pull request) go through GitHub Desktop, with
the terminal kept only as an optional fallback. Includes prominent security
disclaimers (no API keys, secrets or personal data) and a troubleshooting
section.

Signed-off-by: Delmaire Loïc <loic.delmaire@gmail.com>
@skelz0r
skelz0r force-pushed the docs/po-content-editing-guide branch from d3acab7 to befe6bd Compare June 25, 2026 14:02
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.

1 participant