Skip to content

docs: user and developer docs, repo cleanup - #45

Open
Maxaubert wants to merge 10 commits into
mainfrom
docs/25-docs-and-cleanup
Open

Maxaubert wants to merge 10 commits into
mainfrom
docs/25-docs-and-cleanup

Conversation

@Maxaubert

@Maxaubert Maxaubert commented Oct 6, 2026 •

Copy link
Copy Markdown
Owner

Closes #25

Docs

  • New: docs/getting-started.md, docs/operations.md, docs/models.md, docs/architecture.md; docs/cli.md updated (console section rewritten against the code).
  • docs/models.md replaces docs/adding-models.md and docs/comfyui-upscaler-import.md (both removed).
  • README: logo and badges kept, plus a short intro, one screenshot and a Docs list. The "Built with" badge now links to docs/architecture.md instead of the repo itself.
  • CLAUDE.md: real src/ layout (no "(planned)" lines), docs pointers, finished phase notes replaced by a short tools/dependencies note, output naming rule corrected (name.ext, then name (converted).ext, name (converted 2).ext), README direct-commit exception removed to match the PR-for-everything rule. 113 lines.
  • Fixed in operations.md: LibreOffice is bundled (resources\libreoffice), with an installed copy as fallback.

Moves and deletions

  • Mockups: only the chosen designs stay (terminal-v5/10-s2-vscode-grouped, view-zoom/04-explorer-style, console/01-bottom-panel, their shots and impl-* shots, generate-empty/*, cli-settings-skill.png), 42 files. 304 rejected-round files removed (claude*, codex, icons, terminal to terminal-v4, the other v5/view-zoom/console options and galleries), plus the unreferenced docs/design/mockup-*.png. docs/mockups/README.md lists what is kept and how to recover the rest from cc639ad.
  • Research moved out of the repo to C:\Users\Admin\Documents\Claude\research\filesmith\: 2026-08-20-compression-upgrade-plan.md, 2026-08-20-upscaler-upgrade-plan.md, 2026-08-20-dependency-model-audit.md.
  • Screenshots: new docs/screenshots/convert.png, view-large-icons.png, console.png, generate.png, settings.png, captured from the built app (1440x900 window, downscaled to 1920 wide). Removed the pre-redesign queue.png, image-preview.png, upscale.png, viewer.png.

Gates

  • typecheck, lint, prettier --check ., unit tests (902 passed, 1 skipped), build: clean.
  • e2e: 93 passed, 3 skipped (opt-in shot specs). 2 cli-packed tests first failed on a stale unpacked build (0.7.1) and passed after a fresh electron-builder --win dir.
  • Shot specs with FILESMITH_SHOTS=1 (visual, generate-empty, skill): 5 passed, all paths found; the rewritten shots were restored, not committed.

No version bump: only **.md and docs/** changed, which the release workflow ignores.

🤖 Generated with Claude Code

Maxaubert and others added 10 commits October 6, 2026 13:52
Refs #25

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
They now live in C:\Users\Admin\Documents\Claude\research\filesmith\ with
date-prefixed names (2026-08-20-*.md).

Refs #25

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Adds getting-started, operations, models and architecture, updates cli.md,
and removes adding-models.md and comfyui-upscaler-import.md (merged into
models.md).

Refs #25

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Convert with a running job, Large icons, the console, Generate and Settings,
captured from the built app at 1440x900. Removes the pre-redesign shots.

Refs #25

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #25

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… notes

Also corrects operations.md: LibreOffice is bundled (resources/libreoffice),
with an installed copy as fallback.

Refs #25

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Convert format default, the fixed If file exists choice, Upscale ComfyUI
button labels, the Ctrl+backtick code span that swallowed the console
prefix sentence, and embed the four unreferenced screenshots.

Refs #25

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #25

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #25

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #25

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.

Documentation and docs need updating and improving

1 participant