Skip to content

Commit 2420b20

Browse files
matdavematdave
committed
docs: add markup and references to docs
1 parent b1e05dd commit 2420b20

File tree

6 files changed

+58
-11
lines changed

6 files changed

+58
-11
lines changed

‎Writerside/c.list

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@
22
<!DOCTYPE categories
33
SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
44
<categories>
5-
<category id="wrs" name="Writerside documentation" order="1"/>
5+
<category id="related" name="Related topics" order="1"/>
6+
<category id="external" name="External resources" order="2"/>
67
</categories>

‎Writerside/topics/Configuration_Overview.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Use the [Supported Providers](Supported-Providers.md) section to set up your response provider's credentials.
44

5-
## Generative Fields
5+
## Generative Fields {id=generative_fields}
66

77
The default fields modAI enables in the `modai.res.fields` setting are longtitle, description, introtext/summary, and content. You can add additional standard resource fields to this setting.
88

@@ -48,3 +48,9 @@ Each field that you attach modAI to can have settings overrides. This means that
4848
- `modai.api.claude.key` → `{your API key}`
4949
- `modai.res.introtext.model` → `claude-3-5-haiku-20241022`
5050
- `modai.res.introtext.temperature` → `0.9`
51+
52+
<seealso>
53+
<category ref="related">
54+
<a href="Supported-Providers.md" />
55+
</category>
56+
</seealso>

‎Writerside/topics/Cost.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
11
# Cost
22

3-
OpenAI API credits must be purchased for this Extra to work with Image models. Find costs for the various models at https://openai.com/api/pricing/.
3+
OpenAI API credits must be purchased for this Extra to work with Image models. Find costs for the various models: [https://openai.com/api/pricing/](https://openai.com/api/pricing/)
44

5-
Google Gemini offers a variety of free options with limits. Image generation requires payments: https://ai.google.dev/pricing
5+
Google Gemini offers a variety of free options with limits. Image generation requires payments: [https://ai.google.dev/pricing](https://ai.google.dev/pricing)
66

7-
Anthropic API pricing is here: https://www.anthropic.com/pricing#anthropic-api
7+
Anthropic API pricing is here: [https://www.anthropic.com/pricing#anthropic-api](https://www.anthropic.com/pricing#anthropic-api)
88

99
To learn more about managing cost, make sure to use the most optimal models for the type of content you expect your prompts to generate. For example, [1000 tokes is roughly equal to 750 words](https://platform.openai.com/docs/guides/production-best-practices#text-generation); make sure the [model you choose](https://platform.openai.com/docs/guides/model-selection) is the right one for the job at hand.
10+
11+
<seealso>
12+
<category ref="external">
13+
<a href="https://platform.openai.com/docs/guides/">OpenAI Pricing</a>
14+
<a href="https://ai.google.dev/pricing">Gemini Pricing</a>
15+
<a href="https://www.anthropic.com/pricing#anthropic-api">Anthropic Pricing</a>
16+
</category>
17+
</seealso>

‎Writerside/topics/Supported-Providers.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Supported Providers
22

3+
<warning id="key-warning">
4+
Your keys will be exposed to manager users over network requests, so it is recommended to use a site-specific key
5+
that can be easily revoked.
6+
</warning>
7+
38
## ChatGPT (OpenAI)
49

510
ChatGPT is the default model assumed. Fill out the `modai.api.chatgpt.key` and adjust any models as desired.
@@ -44,4 +49,13 @@ To use the custom service, set the following fields:
4449

4550
Then, you for each model you want to use, set the corresponding "model" field with the prefix "custom_" followed by the model name, e.g:
4651

47-
- `modai.global.model` → `custom_llama3.1:8b`
52+
- `modai.global.model` → `custom_llama3.1:8b
53+
54+
<seealso>
55+
<category ref="external">
56+
<a href="https://platform.openai.com/docs/guides/">OpenAI Guides</a>
57+
<a href="https://ai.google.dev/gemini-api/docs/">Gemini Docs</a>
58+
<a href="https://docs.anthropic.com/en/docs/">Anthropic Docs</a>
59+
<a href="https://docs.openwebui.com">Open WebUI Docs</a>
60+
</category>
61+
</seealso>

‎Writerside/topics/Usage.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,9 @@ Wherever you see a field or a label with a “sparkle button” (✦) next to it
88
- **content** – a freeform prompt box allows you to give instructions on the type of content to generate
99

1010
If you’re not happy with what modAI generates, click the sparkle button or generate buttons again to generate another variation. You can then use the prev/next navigation buttons to go between the options. When you save, it keeps the option shown and discards the rest.
11+
12+
<seealso>
13+
<category ref="related">
14+
<a href="Configuration_Overview.md#generative_fields" />
15+
</category>
16+
</seealso>

‎Writerside/topics/index.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,24 @@ The modAI Plugin adds a sparkle button (✦) next to fields or labels in back-en
1111
## Requirements
1212

1313
- MODX Revolution 3.x
14-
- A ChatGPT API key from https://platform.openai.com/api-keys, Google Gemini API key from https://ai.google.dev/gemini-api/docs/api-key or Anthropic Claude API key from https://console.anthropic.com/settings/keys
15-
- Pre-paid credits for API calls for ChatGPT if using—this is different than the $20/month ChatGPT Pro subscription
14+
- An API Key from your [Supported Provider](Supported-Providers.md)
15+
- Pre-paid credits for API calls for ChatGPT if using—this is different from the $20/month ChatGPT Pro subscription
1616

17-
**Note:** image and vision support is currently only supported with the ChatGPT APIs. Claude and Gemini only support text generation.
17+
<note>
18+
Image and vision support is currently only supported with the OpenAI and Gemini. Claude, Ollama and others only support text generation.
19+
</note>
1820

1921
MODX’s modAI Extra works with the following Extras if installed:
2022

21-
- **image+** – for things like Open Graph sharing previews or hero section images with robust output templating, resizing, cropping and format conversions in conjunction with **pThumb** https://extras.modx.com/package/imageplustvinput
22-
- **SEO Suite+** – for managing and previewing SEO-related information for your sites https://extras.modx.com/package/seosuite
23+
- **[image+](https://extras.modx.com/package/imageplustvinput)** – for things like Open Graph sharing previews or hero section images with robust output templating, resizing, cropping and format conversions in conjunction with pThumb
24+
- **[SEO Suite](https://extras.modx.com/package/seosuite)** – for managing and previewing SEO-related information for your sites
25+
26+
<seealso>
27+
<category ref="related">
28+
<a href="Supported-Providers.md" />
29+
</category>
30+
<category ref="external">
31+
<a href="https://extras.modx.com/package/imageplustvinput">Image+</a>
32+
<a href="https://extras.modx.com/package/seosuite">SEO Suite</a>
33+
</category>
34+
</seealso>

0 commit comments

Comments
 (0)