Skip to content

Documentation and docs need updating and improving #25

Description

@Maxaubert

The docs are out of date after the terminal redesign (#22, PR #23) and the README was cut down to logo and badges.

  • Rewrite the README: what Filesmith does, install, the tools, screenshots of the new UI, build from source.
  • Review docs/ (adding-models, compression/upscaler plans, dependency audit) for stale content; archive or update.
  • Document the new UI conventions (docs/design/redesign-direction.md) and keyboard shortcuts.
  • Check CLAUDE.md and the project layout section match the code.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions