`filter-branch` / rebase imminent in the coming weeks

Open
#350 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Refactor
Clarity
Needs clarification
Activity status
Stale
Tech stack
git
Domain
documentation, tooling

Research direction

No files, tests, or entry points are named. Start by reviewing the linked tmuxp issue and the repository-cleanup plans in this issue, then decide whether history cleanup, image relocation, Git LFS, or documentation versioning is in scope. Done should include an agreed approach that reduces repository bloat without breaking downstream use or documentation links.

Written by the indexing model from the issue text.

Description

Same as https://github.com/tmux-python/tmuxp/issues/732, I want to cut down bloat in the repositories.

I will run the same cleanup on tmuxp I do on libtmux, but will also try to curate some screenshots/animated gifs and optimize them well

Potentially i will move binary images to gh-pages or a branch. Not sure.

This is one time thing. Also I think we're too small for git-lfs to make sense but I will investigate the tradeoffs of that.

If we used git-lfs and it didn't break stuff downstream, I'd be much more willing to commit screenshots / graphics and styling.

On word on docs

  1. Further I am concerned that us moving documentation to a different project, e.g. from sphinx to docusaurus, is going to bloat the repo size further. I am still investigating solutions with that.

  2. I am going to investigate porting our docs so they have versioning back to past releases. The problem is if we go with docusaurus, I am concerned on us having a perfect alignment of page links

Dominant language
Python
Stars
1.2k
Forks
127
Avg merge
2h 13m
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from tmux-python/libtmux

All issues in tmux-python/libtmux

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.