Skip to content

Commit d12eaf7

Browse files
authored
add llms.txt (#1757)
1 parent 353f079 commit d12eaf7

File tree

68 files changed

+313
-191
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+313
-191
lines changed

LICENSE

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ The **platformOS Documentation** is licensed under the terms of the [Creative Co
22

33
_Copyright © 2018-2023 platformOS_
44

5-
This is a human-readable summary of (and not a substitute for) the license.
5+
This is a human-readable summary of (and not a substitute for) the license.
66

77
You are free to:
88

@@ -20,4 +20,4 @@ Under the following terms:
2020
Notices:
2121

2222
You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
23-
No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.
23+
No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.

app/graphql/llms_pages.graphql

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
query sitemap_pages($per_page: Int = 1000, $page: Int = 1) {
2+
pages: admin_pages(
3+
per_page: $per_page
4+
page: $page
5+
filter: {
6+
metadata: [
7+
{ has_key: "skip_llms", exclude: true }
8+
]
9+
slug: { not_contains: "api-reference/graphql/" }
10+
}
11+
sort: { slug: { order: ASC } }
12+
) {
13+
total_entries
14+
total_pages
15+
results {
16+
slug
17+
metadata
18+
}
19+
}
20+
}

app/graphql/sitemap_pages.graphql

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,13 @@ query sitemap_pages($per_page: Int = 1000, $page: Int = 1) {
66
metadata: { has_key: "skip_sitemap", exclude: true }
77
slug: { not_contains: "api-reference/graphql/" }
88
}
9+
sort: { slug: { order: ASC } }
910
) {
1011
total_entries
1112
total_pages
1213
results {
1314
slug
15+
metadata
1416
}
1517
}
1618
}

app/views/pages/404.html.liquid

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ metadata:
66
feedback: false
77
breadcrumbs: false
88
last_edit: false
9+
skip_sitemap: true
10+
skip_llms: true
911
---
1012

1113
<!DOCTYPE html>

app/views/pages/404.json.liquid

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
metadata:
3+
skip_sitemap: true
4+
skip_llms: true
5+
---
16
{
27
"error": "not found"
38
}

app/views/pages/404.txt.liquid

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1+
---
2+
metadata:
3+
skip_sitemap: true
4+
skip_llms: true
5+
---
16
This text file does not exist. Double-check the URL in the address bar.

app/views/pages/404.xml.liquid

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
metadata:
3+
skip_sitemap: true
4+
skip_llms: true
5+
---
16
<?xml version="1.0" encoding="UTF-8"?>
27
<Error>
38
<Message>This file does not exist.</Message>

app/views/pages/api-reference/liquid/asset_url.liquid

Lines changed: 0 additions & 41 deletions
This file was deleted.

app/views/pages/api-reference/partner-portal/api/dns.md.liquid

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
metadata:
3-
title: Partner Portal DNS API Documenation
3+
title: Partner Portal DNS API Documentation
44
description: This documentation will help you manage your instance domains programmatically using Partner Portal API.
55
feedback: false
66
toc: false

app/views/pages/community.liquid

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@ converter: markdown
33
metadata:
44
title: Welcome to the platformOS Community!
55
description: Learn, teach, and contribute to our community
6+
skip_llms: true
67
---
78

89
Join in, grow your skills, and find people who share your interest in platformOS. Learn about the many ways you can participate in our community below.
910

1011
## Talk to us and other community members
1112

12-
* **[pOS Community site](https://community.platformos.com/)**: One of our main communication channels is our community site, where you can ask, answer, upvote, and downvote questions, and get to know other members of the platformOS Community. More features coming soon!
13+
* **[pOS Community site](https://community.platformos.com/)**: One of our main communication channels is our community site, where you can ask, answer, upvote, and downvote questions, and get to know other members of the platformOS Community. More features coming soon!
1314
* **Slack support** *(by invite only)*: Join a dedicated Slack channel, where you can ask questions, share ideas, and get to know our team members and each other. You can share what you’ve learned, plan your module development in sync with our roadmap and each other’s projects, and allocate your resources according to what’s going on in the business and the wider community.
1415
* **[Town Hall](https://www.platformos.com/town-hall)**: We have regular video conferences over Zoom, where community members and the platformOS team share news, demo features and modules, and have the opportunity to engage in real-time, face-to-face conversation. Our team and community members are distributed over different continents, so we try to accommodate participants in different time zones by rotating the time of this event so that everyone has the chance to participate. We also share the recording of each meeting.
1516
* **[User experience research](/community/user-research/user-research-platformos)**: Besides getting constant feedback from the community through the channels described above, we plan regular checkpoints in our process to facilitate testing and course-correction. During development, we tie these checkpoints to development phases. At the end of each larger release, we conduct user interviews and compile and share a short survey for community members to fill out. This helps us clarify the roadmap for the next development phase.

0 commit comments

Comments
 (0)