Merged
Conversation
- FAQ: 228 tests → 231 (3 new tests added in v1.0.2) - Install env vars table: example version 1.0.1 → 1.0.2 Signed-off-by: K1-R1 <77465250+K1-R1@users.noreply.github.com>
- Cut generic "AI tools are powerful" opener in Why smoosh — start with
the specific pain point
- Remove abstract "Technical knowledge becomes accessible" sentence and
its negative parallelism ("not just X")
- Replace "No hallucinations, all sources cited" overclaim with factual
"all with source citations"
- Remove chatbot opener from CONTRIBUTING.md
Signed-off-by: K1-R1 <77465250+K1-R1@users.noreply.github.com>
- Remove docs/plans/ plan file that was committed despite docs/ gitignore (git rm --cached — gitignore only prevents untracked files) - Remove .agent/ directory (redundant with CLAUDE.md and CONTRIBUTING.md) - Add .agent/ to .gitignore Local copies preserved. No content changes. Signed-off-by: K1-R1 <77465250+K1-R1@users.noreply.github.com>
Agent rules and workflows are useful for contributors using AI tools other than Claude Code (Codex, Gemini CLI, etc.). Signed-off-by: K1-R1 <77465250+K1-R1@users.noreply.github.com>
…e, including a new "How it Works" section and streamlined installation/usage instructions. Signed-off-by: K1-R1 <77465250+K1-R1@users.noreply.github.com>
…refine editor and git attributes configurations. Signed-off-by: K1-R1 <77465250+K1-R1@users.noreply.github.com>
…d and test artifacts. Signed-off-by: K1-R1 <77465250+K1-R1@users.noreply.github.com>
K1-R1
force-pushed
the
docs/promotional-materials
branch
from
1b118c9 to
f30c0fe
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request delivers significant improvements to documentation, shell completions, and configuration for the
smooshproject. The README has been rewritten for clarity and conciseness, with improved installation, usage, and feature documentation. Additionally, new shell autocompletion scripts for Bash, Zsh, and Fish have been added, making the CLI more user-friendly. Minor configuration adjustments were made to.editorconfigand.gitattributesfor consistency and better handling of files.Documentation improvements:
README.md: clearer quick start, installation, usage, and feature sections; improved AI tool integration guides; more concise FAQ; and better formatting throughout. [1] [2] [3] [4] [5] [6]CONTRIBUTING.mdfor clarity.Shell completions:
completions/smoosh.bash), Zsh (completions/smoosh.zsh), and Fish (completions/smoosh.fish) autocompletion scripts to enhance CLI usability. [1] [2] [3]Configuration and housekeeping:
.editorconfigfor consistent whitespace, charset, and trimming rules..gitattributesto better handle line endings, linguist settings, and to hide golden test outputs from PR diffs and language stats.