Skip to content

Commit 69497ff

Browse files
authored
docs: add llms.txt to docs for AI friendly navigation (#619)
* Add auto-generated llms.txt support for documentation Configure Hugo to auto-generate llms.txt file following the llms.txt specification (https://llmstxt.org). The file provides a structured index of all documentation sections, including summaries from frontmatter, making it easier for LLMs to understand the documentation structure and content. - Add outputFormats configuration in Hugo config for text/plain format - Create index.llms.txt template with dynamic section generation - Uses frontmatter summary field for page descriptions - Includes all 92 CLI commands in Reference section - Optional section for extended context that can be skipped for shorter windows * add summary frontmatter to support description in llms.txt
1 parent bc984ae commit 69497ff

File tree

13 files changed

+86
-0
lines changed

13 files changed

+86
-0
lines changed

docs.kosli.com/config.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ caches:
2525
dir: :cacheDir/:project
2626
maxAge: 30s
2727

28+
outputs:
29+
home:
30+
- HTML
31+
- llms
32+
33+
outputFormats:
34+
llms:
35+
mediaType: text/plain
36+
baseName: llms
37+
isPlainText: true
38+
2839
module:
2940
imports:
3041
- path: github.com/alex-shpak/hugo-book

docs.kosli.com/content/administration/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
title: Administration
33
bookCollapseSection: true
44
weight: 400
5+
summary: "Manage users, roles, and permissions in your Kosli organization. Configure access control and user management settings."
56
---

docs.kosli.com/content/administration/managing_users/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
title: Managing users
33
bookCollapseSection: true
44
weight: 100
5+
summary: "Learn how to manage users, assign roles, and control permissions in Kosli."
56
---

docs.kosli.com/content/implementation_guide/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
title: Implementation guide
33
bookCollapseSection: true
44
weight: 300
5+
summary: "Step-by-step guidance for implementing Kosli in your organization, from initial discovery through scaling across teams."
56
---

docs.kosli.com/content/implementation_guide/phase_1/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
title: "Phase 1: Initial Discovery"
33
bookCollapseSection: true
44
weight: 100
5+
summary: "Understand the roles, responsibilities, and ownership model needed for successful Kosli implementation across your organization."
56
---

docs.kosli.com/content/implementation_guide/phase_1/roles_and_responsibilities/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: "Roles and Responsibilities"
33
bookCollapseSection: true
44
weight: 100
5+
summary: "Understand the roles and responsibilities of different stakeholders during Kosli implementation using the RACI matrix."
56
---
67

78
# Roles and Responsibilities

docs.kosli.com/content/implementation_guide/phase_2/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
title: "Phase 2: Configure Kosli"
33
bookCollapseSection: true
44
weight: 200
5+
summary: "Plan your organizational structure, define naming conventions, and configure SSO for your Kosli deployment."
56
---

docs.kosli.com/content/implementation_guide/phase_2/plan_organizational_structure/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@
22
title: "Plan Organizational Structure"
33
bookCollapseSection: true
44
weight: 100
5+
summary: "Define naming conventions for flows, trails, attestation types, and environments to maintain consistency across your organization."
56
---
67

docs.kosli.com/content/implementation_guide/phase_2/plan_organizational_structure/naming_conventions/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: "Naming Conventions"
33
bookCollapseSection: true
44
weight: 100
5+
summary: "Best practices for creating clear and consistent naming conventions for flows, trails, attestation types, and environments in Kosli."
56
---
67

78
# Naming Conventions

docs.kosli.com/content/implementation_guide/phase_2/plan_organizational_structure/naming_conventions/attestation_types.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: "Attestation Types"
33
bookCollapseSection: false
44
weight: 300
5+
summary: "Naming convention guidance for custom attestation types following the control-objective, evidence-type, detail, and version pattern."
56
---
67

78
# Attestation Types

0 commit comments

Comments
 (0)