Skip to content

Commit

Permalink
fix: add more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
darraghoriordan committed Apr 11, 2023
1 parent 738c375 commit 07a6e5e
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 14 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
title: "Color tool"
title: "Color Tools"
date: "2020-01-01"
order: 2
---

This tool converts colors between different formats. It shows you the nearest TailwindCSS color.
This tool converts colors between different formats.

It shows you the nearest TailwindCSS color to your color.

- hex
- rgb
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "ESLint rule"
title: "AI ESLint Rule Generator"
date: "2020-01-01"
order: 3
---
Expand All @@ -10,12 +10,24 @@ The rule will be passed to a docker container that will run the rule against the

If errors are found, the rule will be updated to fix the errors by AI.

## How to use
## API Notice

Because this uses ChatGPT your criteria data will be sent to OpenAI.

You use your own API key and the requests go directly to OpenAI. There is no Local Dev Tools server involved.

You can read more about their privacy policy [here](https://openai.com/policies/privacy-policy).

## Initial Setup

You must have added an OpenAI API key to your settings.

You must have docker installed and running.

The first time you use this tool it will download the docker image. This might take some extra time. The rest of the time it will start up quickly. The image is about 300MB.

## How to use

Enter the rule criteria, passing tests, and failing tests.

![ESLint rule](../images/eslint_rule_criteria.png)
Expand All @@ -24,6 +36,10 @@ Click the "Generate" button.

The console will update with progress. When the generation is complete a result will be available.

![ESLint rule gen](../images/eslintgen.png)

You can view all the previous rules you've generated. If an error is detected while generating a new "epoch" will be created.

## Errors

If you see an error like
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Git ssh alias urls"
title: "Git SSH Alias Urls"
date: "2020-01-01"
order: 5
---
Expand Down
6 changes: 3 additions & 3 deletions apps/frontend/src/marketing-pages/local-dev-tools/Hero.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ export function Hero({ user }: { user: UserDto }) {
<p className="mt-4 text-left font-display text-lg tracking-tight text-gray-200">
Universal App (Apple Silicon & Intel) -{" "}
<a
href="https://assets.darraghoriordan.com/localDevTools/gr-hosting/1.60.1/LocalDevTools-1.60.1-universal.dmg"
href="https://assets.darraghoriordan.com/localDevTools/gr-hosting/1.60.4/LocalDevTools-1.60.4-universal.dmg"
className="underline underline-offset-2 font-semibold"
>
Download
Expand All @@ -171,7 +171,7 @@ export function Hero({ user }: { user: UserDto }) {
<p className="mt-4 text-left font-display text-lg tracking-tight text-gray-200">
Intel x64 -{" "}
<a
href="https://assets.darraghoriordan.com/localDevTools/gr-hosting/1.60.1/LocalDevTools-1.60.1-x64.exe"
href="https://assets.darraghoriordan.com/localDevTools/gr-hosting/1.60.4/LocalDevTools-1.60.4-x64.exe"
className="underline underline-offset-2 font-semibold"
>
Download
Expand All @@ -180,7 +180,7 @@ export function Hero({ user }: { user: UserDto }) {
<p className="mt-4 text-left font-display text-lg tracking-tight text-gray-200">
Arm 64 -{" "}
<a
href="https://assets.darraghoriordan.com/localDevTools/gr-hosting/1.60.1/LocalDevTools-1.60.1-arm64.exe"
href="https://assets.darraghoriordan.com/localDevTools/gr-hosting/1.60.4/LocalDevTools-1.60.4-arm64.exe"
className="underline underline-offset-2 font-semibold"
>
Download
Expand Down
14 changes: 8 additions & 6 deletions apps/frontend/src/pages/docs/[productKey]/[section]/[slug].tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,14 @@ export async function getStaticProps({
// calculating this locally out of laziness

return {
props: {
productKey: params.productKey,
...titles,
menuSections,
article,
},
props: JSON.parse(
JSON.stringify({
productKey: params.productKey,
...titles,
menuSections,
article,
})
),
};
}

Expand Down

0 comments on commit 07a6e5e

Please sign in to comment.