diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 441c946fd..70f5a5ba2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -154,6 +154,10 @@ The project's documentation is built using Jekyll and hosted on GitHub Pages. To ``` bundle exec jekyll build ``` +5. Preview the website while editing (optional): + ``` + bundle exec jekyll serve + ``` The built documentation will be available in the `aider/website/_site` directory. diff --git a/aider/commands.py b/aider/commands.py index 74a0dd956..977aeba06 100644 --- a/aider/commands.py +++ b/aider/commands.py @@ -735,7 +735,7 @@ class Commands: self.io.tool_output(f"Removed {matched_file} from the chat") def cmd_git(self, args): - "Run a git command" + "Run a git command (output excluded from chat)" combined_output = None try: args = "git " + args diff --git a/aider/website/docs/faq.md b/aider/website/docs/faq.md index 4cd95de74..c120d2ddd 100644 --- a/aider/website/docs/faq.md +++ b/aider/website/docs/faq.md @@ -124,6 +124,9 @@ When starting a fresh aider session, you can include recent git history in the c Remember, the chat history already includes recent changes made during the current session, so this tip is most useful when starting a new aider session and you want to provide context about recent work. +{: .tip } +The `/git` command will not work for this purpose, as its output is not included in the chat. + ## How can I run aider locally from source code? To run the project locally, follow these steps: @@ -194,12 +197,18 @@ Yes, you can now share aider chat logs in a pretty way. 1. Copy the markdown logs you want to share from `.aider.chat.history.md` and make a github gist. Or publish the raw markdown logs on the web any way you'd like. -https://gist.github.com/paul-gauthier/2087ab8b64034a078c0a209440ac8be0 + ``` + https://gist.github.com/paul-gauthier/2087ab8b64034a078c0a209440ac8be0 + ``` 2. Take the gist URL and append it to: -https://aider.chat/share/?mdurl= + ``` + https://aider.chat/share/?mdurl= + ``` This will give you a URL like this, which shows the chat history like you'd see in a terminal: +``` https://aider.chat/share/?mdurl=https://gist.github.com/paul-gauthier/2087ab8b64034a078c0a209440ac8be0 +``` diff --git a/aider/website/docs/usage/commands.md b/aider/website/docs/usage/commands.md index cbdfc4f7c..20456ecc7 100644 --- a/aider/website/docs/usage/commands.md +++ b/aider/website/docs/usage/commands.md @@ -25,7 +25,7 @@ cog.out(get_help_md()) | **/diff** | Display the diff of changes since the last message | | **/drop** | Remove files from the chat session to free up context space | | **/exit** | Exit the application | -| **/git** | Run a git command | +| **/git** | Run a git command (output excluded from chat)| | **/help** | Ask questions about aider | | **/lint** | Lint and fix in-chat files or all dirty files if none in chat | | **/ls** | List all known files and indicate which are included in the chat session |