Skip to content

Commit

Permalink
Merge pull request #7200 from jfkonecn/website-llm-docs
Browse files Browse the repository at this point in the history
Added llms.txt
  • Loading branch information
lukewilliamboswell authored Nov 9, 2024
2 parents db017de + 6b42d03 commit b7c2cb0
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
4 changes: 4 additions & 0 deletions www/content/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
<p>Roc doesn’t have a numbered release or an installer yet, but you can follow the install instructions for your OS<a href="/install/getting_started.html#installation"> here </a>. If you get stuck, friendly people will be happy to help if you open a topic in<a href="https://roc.zulipchat.com/#narrow/stream/231634-beginners"> #beginners </a>on<a href="https://roc.zulipchat.com/"> Roc Zulip Chat </a>and ask for assistance!</p>
</section>

## [LLM Docs](#llm-docs) {#llm-docs}

We have experimental LLM-friendly text files for our [tutorial](/llms.txt) and [standard library](/builtins/llms.txt) that you can use to prompt your favorite LLM to answer your questions about Roc!

## [REPL](#repl) {#repl}

Let's start by getting acquainted with Roc's [_Read-Eval-Print-Loop_](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop), or **REPL** for short.
Expand Down
4 changes: 4 additions & 0 deletions www/main.roc
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,15 @@ import pf.SSG
import pf.Types exposing [Args]
import pf.Html exposing [header, nav, div, link, attribute, text, a, span, html, head, body, meta, script, footer, br]
import pf.Html.Attributes exposing [id, ariaLabel, ariaHidden, title, href, class, rel, type, content, lang, charset, name, color]
import "content/tutorial.md" as tutorialMarkdown : Str

import InteractiveExample

main : Args -> Task {} _
main = \{ inputDir, outputDir } ->

SSG.writeFile! { outputDir, relpath: Types.toRelPath "llms.txt", content: tutorialMarkdown }

# get the path and url of markdown files in content directory
files = SSG.files! inputDir

Expand Down

0 comments on commit b7c2cb0

Please sign in to comment.