diff --git a/docs.kosli.com/config.yaml b/docs.kosli.com/config.yaml index 0f4d18c3a..864752645 100644 --- a/docs.kosli.com/config.yaml +++ b/docs.kosli.com/config.yaml @@ -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 \ No newline at end of file diff --git a/docs.kosli.com/content/administration/_index.md b/docs.kosli.com/content/administration/_index.md index ac45b6c90..fc1a839f9 100644 --- a/docs.kosli.com/content/administration/_index.md +++ b/docs.kosli.com/content/administration/_index.md @@ -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." --- \ No newline at end of file diff --git a/docs.kosli.com/content/administration/managing_users/_index.md b/docs.kosli.com/content/administration/managing_users/_index.md index 3511f326d..030bce2cf 100644 --- a/docs.kosli.com/content/administration/managing_users/_index.md +++ b/docs.kosli.com/content/administration/managing_users/_index.md @@ -2,4 +2,5 @@ title: Managing users bookCollapseSection: true weight: 100 +summary: "Learn how to manage users, assign roles, and control permissions in Kosli." --- \ No newline at end of file diff --git a/docs.kosli.com/content/implementation_guide/_index.md b/docs.kosli.com/content/implementation_guide/_index.md index 001b4b50d..8b311bebf 100644 --- a/docs.kosli.com/content/implementation_guide/_index.md +++ b/docs.kosli.com/content/implementation_guide/_index.md @@ -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." --- \ No newline at end of file diff --git a/docs.kosli.com/content/implementation_guide/phase_1/_index.md b/docs.kosli.com/content/implementation_guide/phase_1/_index.md index d736d66c6..c42c2453e 100644 --- a/docs.kosli.com/content/implementation_guide/phase_1/_index.md +++ b/docs.kosli.com/content/implementation_guide/phase_1/_index.md @@ -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." --- \ No newline at end of file diff --git a/docs.kosli.com/content/implementation_guide/phase_1/roles_and_responsibilities/_index.md b/docs.kosli.com/content/implementation_guide/phase_1/roles_and_responsibilities/_index.md index 312c91be0..4bb70eb4c 100644 --- a/docs.kosli.com/content/implementation_guide/phase_1/roles_and_responsibilities/_index.md +++ b/docs.kosli.com/content/implementation_guide/phase_1/roles_and_responsibilities/_index.md @@ -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 diff --git a/docs.kosli.com/content/implementation_guide/phase_2/_index.md b/docs.kosli.com/content/implementation_guide/phase_2/_index.md index 7eee494a3..a96f87fbf 100644 --- a/docs.kosli.com/content/implementation_guide/phase_2/_index.md +++ b/docs.kosli.com/content/implementation_guide/phase_2/_index.md @@ -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." --- \ No newline at end of file diff --git a/docs.kosli.com/content/implementation_guide/phase_2/plan_organizational_structure/_index.md b/docs.kosli.com/content/implementation_guide/phase_2/plan_organizational_structure/_index.md index 730997241..f65adf8cb 100644 --- a/docs.kosli.com/content/implementation_guide/phase_2/plan_organizational_structure/_index.md +++ b/docs.kosli.com/content/implementation_guide/phase_2/plan_organizational_structure/_index.md @@ -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." --- diff --git a/docs.kosli.com/content/implementation_guide/phase_2/plan_organizational_structure/naming_conventions/_index.md b/docs.kosli.com/content/implementation_guide/phase_2/plan_organizational_structure/naming_conventions/_index.md index 84d3d1772..771326eda 100644 --- a/docs.kosli.com/content/implementation_guide/phase_2/plan_organizational_structure/naming_conventions/_index.md +++ b/docs.kosli.com/content/implementation_guide/phase_2/plan_organizational_structure/naming_conventions/_index.md @@ -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 diff --git a/docs.kosli.com/content/implementation_guide/phase_2/plan_organizational_structure/naming_conventions/attestation_types.md b/docs.kosli.com/content/implementation_guide/phase_2/plan_organizational_structure/naming_conventions/attestation_types.md index ccdec0512..68d7a79e9 100644 --- a/docs.kosli.com/content/implementation_guide/phase_2/plan_organizational_structure/naming_conventions/attestation_types.md +++ b/docs.kosli.com/content/implementation_guide/phase_2/plan_organizational_structure/naming_conventions/attestation_types.md @@ -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 diff --git a/docs.kosli.com/content/implementation_guide/phase_2/plan_organizational_structure/naming_conventions/flows_and_trails.md b/docs.kosli.com/content/implementation_guide/phase_2/plan_organizational_structure/naming_conventions/flows_and_trails.md index 00d7121cb..33d112a06 100644 --- a/docs.kosli.com/content/implementation_guide/phase_2/plan_organizational_structure/naming_conventions/flows_and_trails.md +++ b/docs.kosli.com/content/implementation_guide/phase_2/plan_organizational_structure/naming_conventions/flows_and_trails.md @@ -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 diff --git a/docs.kosli.com/content/implementation_guide/phase_2/sso_configuration.md b/docs.kosli.com/content/implementation_guide/phase_2/sso_configuration.md index 0a8884aa0..a55ec3ddc 100644 --- a/docs.kosli.com/content/implementation_guide/phase_2/sso_configuration.md +++ b/docs.kosli.com/content/implementation_guide/phase_2/sso_configuration.md @@ -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 diff --git a/docs.kosli.com/layouts/index.llms.txt b/docs.kosli.com/layouts/index.llms.txt new file mode 100644 index 000000000..d756c3e08 --- /dev/null +++ b/docs.kosli.com/layouts/index.llms.txt @@ -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 }}