Skip to content
This repository was archived by the owner on Mar 21, 2026. It is now read-only.

docs: fix documentation inaccuracies#319

Merged
zhubert merged 1 commit intomainfrom
docs/fix-documentation-accuracy
Mar 7, 2026
Merged

docs: fix documentation inaccuracies#319
zhubert merged 1 commit intomainfrom
docs/fix-documentation-accuracy

Conversation

@zhubert
Copy link
Copy Markdown
Owner

@zhubert zhubert commented Mar 7, 2026

Summary

  • CLAUDE.md: Remove nonexistent demo/ package, fix session_manager.go location (app/ → manager/), add 9 undocumented packages, add Linear to issues/ description, fix runner map name (claudeRunnersrunners), fix MCP socket path format
  • README.md: Fix theme switching claim (no t shortcut exists — themes are changed via settings modal)
  • docs/index.html: Replace removed workflow config feature card with per-repo settings, fix broken #usage footer anchor → #quick-start

Test plan

  • Verify all CLAUDE.md package paths match internal/ directory listing
  • Confirm no broken links in index.html footer
  • Spot-check keyboard shortcuts in README against shortcuts.go

🤖 Generated with Claude Code

Verified all documentation against the codebase and fixed 9 issues:
- Remove nonexistent demo/ package from CLAUDE.md
- Move session_manager.go reference from app/ to manager/
- Add 9 undocumented packages to CLAUDE.md package structure
- Add Linear to issues/ package description
- Fix runner map name (claudeRunners → runners)
- Fix MCP socket path format (pl-<shortID>.sock)
- Fix theme switching claim in README (no 't' shortcut)
- Replace removed workflow config feature card in index.html
- Fix broken #usage footer link in index.html

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings March 7, 2026 17:28
@zhubert zhubert merged commit f2bcdc8 into main Mar 7, 2026
3 checks passed
@zhubert zhubert deleted the docs/fix-documentation-accuracy branch March 7, 2026 17:32
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates public-facing documentation to better match the current behavior and structure of the codebase (package layout, UI behavior, and documentation site links).

Changes:

  • Update docs landing page feature card content and fix the footer “docs” anchor link.
  • Correct README theme-switching instructions.
  • Refresh CLAUDE.md package tree and various implementation details (runner map name, session manager location, MCP socket path format, issue providers).

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
docs/index.html Renames a feature card and fixes the footer docs link anchor.
README.md Corrects theme switching instructions to reflect current UX.
CLAUDE.md Updates internal package inventory and several implementation details.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +660 to +661
configure allowed tools, squash-on-merge, and issue provider
mapping per repository via the settings modal.
Copy link

Copilot AI Mar 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new feature card text says allowed tools and squash-on-merge can be configured “via the settings modal”, but the current Settings modal only exposes theme/branch prefix/notifications/auto-cleanup (see internal/ui/modals/config.go), and there doesn’t appear to be UI for repo-level allowed tools or squash-on-merge. Consider adjusting this copy to match the actual configuration surfaces (e.g., allowed tools via permission prompts / config file; issue mapping via session settings; remove squash-on-merge mention unless it’s user-configurable in the UI).

Suggested change
configure allowed tools, squash-on-merge, and issue provider
mapping per repository via the settings modal.
configure allowed tools via permission prompts or config file,
and issue provider mapping via session settings, per repository.

Copilot uses AI. Check for mistakes.

1. Claude CLI started with `--permission-prompt-tool mcp__plural__permission`
2. MCP server communicates with TUI via Unix socket (`/tmp/plural-<session-id>.sock`)
2. MCP server communicates with TUI via Unix socket (`/tmp/pl-<shortID>.sock`, first 12 chars of session ID)
Copy link

Copilot AI Mar 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The socket path is documented as /tmp/pl-<shortID>.sock, but the implementation uses filepath.Join(os.TempDir(), "pl-"+shortID+".sock") (internal/mcp/socket.go). os.TempDir() is not always /tmp (e.g., macOS often uses /var/folders/...). Consider documenting it as $TMPDIR/pl-<shortID>.sock (or “in the OS temp dir”) to avoid inaccuracy.

Suggested change
2. MCP server communicates with TUI via Unix socket (`/tmp/pl-<shortID>.sock`, first 12 chars of session ID)
2. MCP server communicates with TUI via Unix socket in the OS temp directory (e.g., `$TMPDIR/pl-<shortID>.sock`, first 12 chars of session ID)

Copilot uses AI. Check for mistakes.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants