Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs.kosli.com/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,17 @@ caches:
dir: :cacheDir/:project
maxAge: 30s

outputs:
home:
- HTML
- llms

outputFormats:
llms:
mediaType: text/plain
baseName: llms
isPlainText: true

module:
imports:
- path: github.com/alex-shpak/hugo-book
1 change: 1 addition & 0 deletions docs.kosli.com/content/administration/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
title: Administration
bookCollapseSection: true
weight: 400
summary: "Manage users, roles, and permissions in your Kosli organization. Configure access control and user management settings."
---
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
title: Managing users
bookCollapseSection: true
weight: 100
summary: "Learn how to manage users, assign roles, and control permissions in Kosli."
---
1 change: 1 addition & 0 deletions docs.kosli.com/content/implementation_guide/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
title: Implementation guide
bookCollapseSection: true
weight: 300
summary: "Step-by-step guidance for implementing Kosli in your organization, from initial discovery through scaling across teams."
---
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
title: "Phase 1: Initial Discovery"
bookCollapseSection: true
weight: 100
summary: "Understand the roles, responsibilities, and ownership model needed for successful Kosli implementation across your organization."
---
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Roles and Responsibilities"
bookCollapseSection: true
weight: 100
summary: "Understand the roles and responsibilities of different stakeholders during Kosli implementation using the RACI matrix."
---

# Roles and Responsibilities
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
title: "Phase 2: Configure Kosli"
bookCollapseSection: true
weight: 200
summary: "Plan your organizational structure, define naming conventions, and configure SSO for your Kosli deployment."
---
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@
title: "Plan Organizational Structure"
bookCollapseSection: true
weight: 100
summary: "Define naming conventions for flows, trails, attestation types, and environments to maintain consistency across your organization."
---

Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Naming Conventions"
bookCollapseSection: true
weight: 100
summary: "Best practices for creating clear and consistent naming conventions for flows, trails, attestation types, and environments in Kosli."
---

# Naming Conventions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Attestation Types"
bookCollapseSection: false
weight: 300
summary: "Naming convention guidance for custom attestation types following the control-objective, evidence-type, detail, and version pattern."
---

# Attestation Types
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Flows and Trails"
bookCollapseSection: false
weight: 200
summary: "Naming convention recommendations for flows and trails, including build flows, release flows, and trails with examples and regex patterns."
---
# Flows and Trails Naming Conventions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "SSO Configuration"
bookCollapseSection: false
weight: 200
summary: "Step-by-step guide for configuring Single Sign-On (SSO) with Microsoft Entra ID for your Kosli organization."
---

# Microsoft Entra ID Setup for SSO
Expand Down
64 changes: 64 additions & 0 deletions docs.kosli.com/layouts/index.llms.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Kosli Documentation

> Record all of the changes in your software and business processes so you can prove compliance and maintain security without slowing down. Track and query every change from the command line or browser.

## Documentation Sections

{{- $sections := slice "understand_kosli" "getting_started" "tutorials" "implementation_guide" "administration" "integrations" }}

{{- range $sections }}
{{- $sectionPages := where $.Site.Pages "Section" . }}
{{- if $sectionPages }}

## {{ humanize . | title }}

{{- range $sectionPages }}
{{- if not .IsHome }}
- [{{ .Title }}]({{ .RelPermalink }}){{- if .Params.summary }}: {{ .Params.summary | plainify | truncate 200 "..." }}{{- end }}
{{- end }}
{{- end }}
{{- end }}
{{- end }}

## Reference

### Client Reference
{{- $clientRefPages := where $.Site.Pages "Section" "client_reference" }}
{{- if $clientRefPages }}
{{- range $clientRefPages }}
{{- if not .IsHome }}
- [{{ .Title }}]({{ .RelPermalink }})
{{- end }}
{{- end }}
{{- end }}

### API References
{{- $apiRefPages := where $.Site.Pages "Section" "api_reference" }}
{{- if $apiRefPages }}
{{- range $apiRefPages }}
{{- if not .IsHome }}
- [{{ .Title }}]({{ .RelPermalink }})
{{- end }}
{{- end }}
{{- end }}

### Additional References
{{- $additionalPages := where $.Site.Pages "Section" (slice "faq" "migrations" "template_ref" "legacy_ref") }}
{{- if $additionalPages }}
{{- range $additionalPages }}
{{- if not .IsHome }}
- [{{ .Title }}]({{ .RelPermalink }})
{{- end }}
{{- end }}
{{- end }}

## Optional

The following sections provide additional context but can be skipped for shorter context windows:

### All Pages

{{- $allPages := where $.Site.Pages "Kind" "page" }}
- Total documentation pages: {{ len $allPages }}
- Last updated: {{ now.Format "2006-01-02 15:04:05 MST" }}
- Base URL: {{ .Site.BaseURL }}