Skip to content

Commit a834adb

Browse files
committed
README: Formatting tweaks and fix broken link
* README.org: Update wiki links and tweak some descriptions.
1 parent 4c0583b commit a834adb

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.org

+11-11
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ https://github-production-user-asset-6210df.s3.amazonaws.com/8607532/278854024-a
4141
- Supports conversations and multiple independent sessions.
4242
- Save chats as regular Markdown/Org/Text files and resume them later.
4343
- You can go back and edit your previous prompts or LLM responses when continuing a conversation. These will be fed back to the model.
44-
- Don't like gptel's workflow? Use it to create your own for any supported model/backend with a [[https://github.com/karthink/gptel/wiki#defining-custom-gptel-commands][simple API]].
44+
- Don't like gptel's workflow? Use it to create your own for any supported model/backend with a [[https://github.com/karthink/gptel/wiki/Defining-custom-gptel-commands][simple API]].
4545

4646
gptel uses Curl if available, but falls back to url-retrieve to work without external dependencies.
4747

@@ -615,12 +615,12 @@ The above code makes the backend available to select. If you want it to be the
615615
| =gptel-menu= | /(Same)/ |
616616
|--------------------+---------------------------------------------------------------|
617617

618-
|------------------+--------------------------------------------------------------------------------------|
619-
| *To add context* | Also available from the Transient menu |
620-
|------------------+--------------------------------------------------------------------------------------|
621-
| =gptel-add= | Add/remove a region or buffer to gptel's context. Add/remove marked files in Dired. |
622-
| =gptel-add-file= | Add a (text-readable) file to gptel's context. |
623-
|------------------+--------------------------------------------------------------------------------------|
618+
|------------------+-----------------------------------------------------------------------------------------|
619+
| *To add context* | |
620+
|------------------+-----------------------------------------------------------------------------------------|
621+
| =gptel-add= | Add/remove a region or buffer to gptel's context. Add/remove marked files in Dired. |
622+
| =gptel-add-file= | Add a (text-readable) file to gptel's context. Also available from the transient menu. |
623+
|------------------+-----------------------------------------------------------------------------------------|
624624

625625
|----------------------------+----------------------------------------------------------------------------|
626626
| *In Org mode only* | |
@@ -635,7 +635,7 @@ The above code makes the backend available to select. If you want it to be the
635635

636636
2. If a region is selected, the conversation will be limited to its contents.
637637

638-
3. Call =M-x gptel-send= with a prefix argument (~C-u~) to
638+
3. Call =M-x gptel-send= with a prefix argument (~C-u~)
639639
- to set chat parameters (GPT model, system message etc) for this buffer,
640640
- include quick instructions for the next request only,
641641
- to add additional context -- regions, buffers or files -- to gptel,
@@ -753,7 +753,7 @@ Now these will be enabled whenever you send a query from the transient menu. If
753753
(keymap-global-set "<f6>" "C-u C-c <return> <return>")
754754
#+end_src
755755

756-
Or see this [[https://github.com/karthink/gptel/wiki#save-transient-flags][wiki entry]].
756+
Or see this [[https://github.com/karthink/gptel/wiki/Commonly-requested-features#save-transient-flags][wiki entry]].
757757

758758
#+html: </details>
759759
#+html: <details><summary>
@@ -762,7 +762,7 @@ Or see this [[https://github.com/karthink/gptel/wiki#save-transient-flags][wiki
762762

763763
gptel's default usage pattern is simple, and will stay this way: Read input in any buffer and insert the response below it. Some custom behavior is possible with the transient menu (=C-u M-x gptel-send=).
764764

765-
For more programmable usage, gptel provides a general =gptel-request= function that accepts a custom prompt and a callback to act on the response. You can use this to build custom workflows not supported by =gptel-send=. See the documentation of =gptel-request=, and the [[https://github.com/karthink/gptel/wiki][wiki]] for examples.
765+
For more programmable usage, gptel provides a general =gptel-request= function that accepts a custom prompt and a callback to act on the response. You can use this to build custom workflows not supported by =gptel-send=. See the documentation of =gptel-request=, and the [[https://github.com/karthink/gptel/wiki/Defining-custom-gptel-commands][wiki]] for examples.
766766

767767
#+html: </details>
768768
#+html: <details><summary>
@@ -867,7 +867,7 @@ Maybe, I'd like to experiment a bit more first. Features added since the incept
867867
- Curl support (=gptel-use-curl=)
868868
- Streaming responses (=gptel-stream=)
869869
- Cancelling requests in progress (=gptel-abort=)
870-
- General API for writing your own commands (=gptel-request=, [[https://github.com/karthink/gptel/wiki][wiki]])
870+
- General API for writing your own commands (=gptel-request=, [[https://github.com/karthink/gptel/wiki/Defining-custom-gptel-commands][wiki]])
871871
- Dispatch menus using Transient (=gptel-send= with a prefix arg)
872872
- Specifying the conversation context size
873873
- GPT-4 support

0 commit comments

Comments
 (0)