Skip to content

Commit 5f6ddb1

Browse files
PredictabilityAtScalePredictabilityAtScale
committed
WEBSITE: Add docs using Docsify
1 parent 3266bec commit 5f6ddb1

6 files changed

Lines changed: 89 additions & 1 deletion

File tree

‎.github/workflows/website.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ on:
55
branches: [main]
66
paths:
77
- 'website/**'
8+
- 'docs/**'
89
workflow_dispatch:
910

1011
permissions:
@@ -23,6 +24,9 @@ jobs:
2324
role-to-assume: ${{ secrets.AWS_ROLE_ARN }}
2425
aws-region: us-east-1
2526

27+
- name: Copy docs into website
28+
run: cp docs/*.md website/docs/
29+
2630
- name: Deploy to S3
2731
run: aws s3 sync website/ s3://${{ secrets.AWS_S3_BUCKET }} --delete
2832

‎website/docs/.nojekyll‎

Whitespace-only changes.

‎website/docs/_sidebar.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
- [Home](/)
2+
3+
- **Guides**
4+
- [Getting Started](getting-started.md)
5+
- [Prompt Format](prompt-format.md)
6+
- [Composition](composition.md)
7+
- [Overrides](overrides.md)
8+
- [Providers](providers.md)
9+
- [Inline Source](inline-source.md)
10+
- [Publishing](publishing.md)
11+
12+
- **Reference**
13+
- [CLI](cli.md)
14+
- [API Reference](api-reference.md)
15+
- [Schema](schema.md)
16+
- [Testing](testing.md)
17+
- [Validation](validation.md)

‎website/docs/index.html‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<title>PromptOpsKit Docs</title>
7+
<meta name="description" content="Documentation for PromptOpsKit — centralize AI prompt behavior in your codebase." />
8+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css" />
9+
<style>
10+
:root {
11+
--base-font-family: Inter, -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
12+
--theme-color: #0f172a;
13+
--sidebar-width: 16rem;
14+
}
15+
.app-nav {
16+
position: fixed;
17+
top: 0;
18+
right: 1rem;
19+
z-index: 10;
20+
}
21+
.app-nav a {
22+
color: #475467;
23+
text-decoration: none;
24+
font-weight: 500;
25+
margin-left: 1rem;
26+
}
27+
.app-nav a:hover {
28+
text-decoration: underline;
29+
}
30+
</style>
31+
</head>
32+
<body>
33+
<nav class="app-nav">
34+
<a href="/">← Home</a>
35+
<a href="https://github.com/PredictabilityAtScale/promptopskit">GitHub</a>
36+
</nav>
37+
<div id="app"></div>
38+
<script>
39+
window.$docsify = {
40+
name: 'PromptOpsKit',
41+
repo: 'https://github.com/PredictabilityAtScale/promptopskit',
42+
loadSidebar: true,
43+
subMaxLevel: 2,
44+
homepage: 'index.md',
45+
auto2top: true,
46+
search: {
47+
placeholder: 'Search docs',
48+
noData: 'No results',
49+
depth: 3,
50+
},
51+
};
52+
</script>
53+
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js"></script>
54+
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.min.js"></script>
55+
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
56+
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-typescript.min.js"></script>
57+
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-yaml.min.js"></script>
58+
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-json.min.js"></script>
59+
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-markdown.min.js"></script>
60+
</body>
61+
</html>

‎website/index.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@
6363
<a href="#quickstart">How</a>
6464
<a href="#features">Features</a>
6565
<a href="#faq">FAQ</a>
66+
<a href="/docs/">Docs</a>
6667
</nav>
6768
<a class="button button-primary" href="https://github.com/PredictabilityAtScale/promptopskit">GitHub</a>
6869
</div>

‎website/sitemap.xml‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
4-
<loc>https://github.com/PredictabilityAtScale/promptopskit</loc>
4+
<loc>https://promptopskit.com</loc>
5+
<changefreq>weekly</changefreq>
6+
<priority>1.0</priority>
7+
</url>
8+
<url>
9+
<loc>https://promptopskit.com/docs/</loc>
510
<changefreq>weekly</changefreq>
611
<priority>0.8</priority>
712
</url>

0 commit comments

Comments
 (0)