Skip to content

docs: streamline README and add command documentation#29

Merged
luqven merged 1 commit intomasterfrom
docs/streamline-readme
Dec 29, 2025
Merged

docs: streamline README and add command documentation#29
luqven merged 1 commit intomasterfrom
docs/streamline-readme

Conversation

@luqven
Copy link
Owner

@luqven luqven commented Dec 29, 2025

Summary

  • Streamline README to lead with features, not background
  • Add dedicated docs for each command with usage, flags, and examples
  • Add troubleshooting guide for common issues
  • Remove unused images
  • Move attribution to bottom of README

Changes

README.md

  • Features section at top
  • Concise command reference with links to detailed docs
  • Collapsible examples
  • Simplified workflow section

docs/

  • log.md - tree visualization command
  • annotate.md - PR description tables
  • land.md - stack merging
  • autorebase.md - automatic stack rebuilding
  • rebase.md - manual rebase script generation
  • troubleshooting.md - common issues and solutions

Removed

  • All images in img/ (replaced with ASCII examples)

@luqven luqven merged commit 09d77c5 into master Dec 29, 2025
1 check passed
@luqven luqven deleted the docs/streamline-readme branch December 29, 2025 17:09
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.

1 participant