docs: simplify guides and publish deployment examples #99

Merged

eleith merged 1 commits from docs/directory-style into main 2026-10-27 02:10:09 +00:00

Conversation 0 Commits 1 Files Changed 19

+662 -1689

eleith-gitea-agent Bot commented 2026-10-27 01:17:38 +00:00

Copy link

Copy source

Summary

• Match Directory's short, frank documentation style, including the owner's second pass. Cut API inventories and architecture narration; package/app READMEs mostly fit in two sentences.
• Put config and environment examples in docs, add a standalone Compose sample using published images, and simplify the README to download/configure/start.
• Update relocated example tests and CLI/boot guidance. Keep brief permissions, environment recreation, backup and grouped-update notes; fix stale links and claims.

Validation

• Owner review, followed by clear independent correctness/readability reviews.
• Four existing tests passed: config example validation/field coverage and CLI config initialization/overwrite protection.
• Changed TypeScript ESLint, formatting and diff checks passed; 29 local documentation links/anchors resolve; both YAML samples parse.
• No new tests or dependencies. No images pulled, containers started, live providers contacted, or full browser suite run. Compose runtime and image availability were not exercised. Remote CI is separate.

## Summary - Match Directory's short, frank documentation style, including the owner's second pass. Cut API inventories and architecture narration; package/app READMEs mostly fit in two sentences. - Put config and environment examples in docs, add a standalone Compose sample using published images, and simplify the README to download/configure/start. - Update relocated example tests and CLI/boot guidance. Keep brief permissions, environment recreation, backup and grouped-update notes; fix stale links and claims. ## Validation - Owner review, followed by clear independent correctness/readability reviews. - Four existing tests passed: config example validation/field coverage and CLI config initialization/overwrite protection. - Changed TypeScript ESLint, formatting and diff checks passed; 29 local documentation links/anchors resolve; both YAML samples parse. - No new tests or dependencies. No images pulled, containers started, live providers contacted, or full browser suite run. Compose runtime and image availability were not exercised. Remote CI is separate.

eleith-gitea-agent Bot added 1 commit 2026-10-27 01:17:38 +00:00

docs: simplify guides and publish deployment examples bed14f9428

eleith merged commit bed14f9428 into main 2026-10-27 02:10:09 +00:00

eleith deleted branch docs/directory-style 2026-10-27 02:10:09 +00:00

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

Clear labels

blocked

Waiting on a prerequisite before work can proceed

bug

Something is not working

enhancement

New feature

No labels

Milestone

No items

No Milestone

Assignees

Clear assignees

eleith-gitea-agent Bot eleith (eleith)

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: eleith/when#99