-
Notifications
You must be signed in to change notification settings - Fork 35
/
readme-updater.genai.mts
43 lines (31 loc) · 1.57 KB
/
readme-updater.genai.mts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
script({
description: "Maintenance script for the README that imports information from the documentation and samples to make it more attractive to users.",
tools: ["fs"],
})
def("README", { filename: "README.md" })
def("FEATURES", { filename: "docs/src/content/docs/index.mdx" })
$`You are an expert open source maintainer.
# Task 1
Analyze the README file of the project using GitHub Flavored Markdown (GFM). Generate ideas to improve it, if any.
# Task 2
Update the README file of the project
- Enhance the content to make it attractive to users.
- Follow best practices for README files in open source projects.
- Document features listed in FEATURES file.
- inline snippets from samples and documentation to illustrate features. link to documentation
- Do NOT MODIFY the "Contributing" and "Trademarks" sections. THIS IS VERY VERY IMPORTANT.
- Do NOT generate any legal guideline.
- use emojis
- do not make changes if not necessary
- Avoid table of contents
- Do not inline installation instructions, link to online documentation
# File information
- documentation: docs/src/content/docs/**/*.md*
- type definition: genaisrc/genaiscript.d.ts
- samples: packages/sample/genaisrc/*.genai.*s
- online documentation: https://microsoft.github.io/genaiscript/ . The routing is docs/src/content/docs/**/<route>.md* becomes https://microsoft.github.io/genaiscript/<route>.
- use links to online documentation
- github repository: https://github.com/microsoft/genaiscript
- the package.json contains helpful scripts, the project uses yarn and is codespace ready
`
defFileOutput("README.md")