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
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,20 @@ conditional: [tenant, nav, ssb]
^^^^^^--- the keyword "tenant" is required to exclude all not mentioned
```

## llms.txt curation

Add selected entry-point pages to `llms.txt` with global ordering metadata:

```yaml
llms:
section: Workloads
order: 30
```

Pages are grouped by `section` and ordered by the numeric `order`. Every
rendered documentation page is also available as Markdown at its canonical
path with a `.md` suffix; the root `README.md` is `/index.md`.

## Copilot Agents

Four agents handle documentation tasks:
Expand Down
3 changes: 3 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Nais Developer Documentation
llms:
section: Core and getting started
order: 10
hide:
- feedback
- footer
Expand Down
3 changes: 3 additions & 0 deletions docs/auth/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
tags: [auth, explanation]
llms:
section: Authentication
order: 100
description: Services and addons to support authentication and authorization in your applications.
---

Expand Down
3 changes: 3 additions & 0 deletions docs/auth/entra-id/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
tags: [auth, entra-id, azure-ad, services, explanation]
llms:
section: Authentication
order: 110
conditional: [tenant, nav]
---

Expand Down
3 changes: 3 additions & 0 deletions docs/auth/idporten/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
tags: [auth, idporten, services, explanation]
llms:
section: Authentication
order: 120
conditional: [tenant, nav]
---

Expand Down
3 changes: 3 additions & 0 deletions docs/build/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
tags: [build, deploy, explanation, services]
llms:
section: Build and deploy
order: 40
---

# Build and deploy
Expand Down
3 changes: 3 additions & 0 deletions docs/build/how-to/build-and-deploy.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
tags: [build, deploy, how-to]
llms:
section: Build and deploy
order: 50
---

# Build and deploy with GitHub Actions
Expand Down
3 changes: 3 additions & 0 deletions docs/explanations/nais.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
tags: [explanation, nais]
llms:
section: Core and getting started
order: 20
---

# What is Nais?
Expand Down
3 changes: 3 additions & 0 deletions docs/observability/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ description: >-
search:
boost: 1
tags: [explanation, observability]
llms:
section: Observability
order: 180
---

# Observability
Expand Down
3 changes: 3 additions & 0 deletions docs/observability/logging/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
description: Understand how application logging works in Nais, its purpose, good practices, and the available log destinations.
tags: [explanation, logging, observability, services]
llms:
section: Observability
order: 190
---

# Logging
Expand Down
3 changes: 3 additions & 0 deletions docs/observability/metrics/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
description: Metrics are a way to measure the state of your application and can be used to create alerts and dashboards in Grafana.
tags: [explanation, metrics, observability, services]
llms:
section: Observability
order: 200
---

# Metrics
Expand Down
3 changes: 3 additions & 0 deletions docs/observability/tracing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
description: >-
Application Performance Monitoring or tracing using Grafana Tempo on Nais.
tags: [explanation, observability, tracing, services]
llms:
section: Observability
order: 210
---

# Distributed Tracing
Expand Down
3 changes: 3 additions & 0 deletions docs/operate/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
tags: [explanation, operate]
llms:
section: Services and operations
order: 240
---

# Manage your workloads and services
Expand Down
3 changes: 3 additions & 0 deletions docs/persistence/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ description: >-
Nais offers several storage solutions for storing data. This page describes
the different options and how to use them.
tags: [persistence, explanation]
llms:
section: Persistence
order: 130
---

# Persistent Data Overview
Expand Down
3 changes: 3 additions & 0 deletions docs/persistence/cloudsql/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
tags: [explanation, persistence, services]
llms:
section: Persistence
order: 150
---

# Google Cloud SQL / PostgreSQL
Expand Down
3 changes: 3 additions & 0 deletions docs/persistence/kafka/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ description: >-
subscribe to streams of records. It is a good alternative to synchronous
communication between services if you need to decouple services.
tags: [kafka, explanation, persistence, services]
llms:
section: Persistence
order: 140
---

# Kafka
Expand Down
3 changes: 3 additions & 0 deletions docs/persistence/opensearch/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
tags: [opensearch, explanation, persistence, services]
llms:
section: Persistence
order: 160
description: >-
Nais provides managed search index services through OpenSearch as a drop-in
replacement for Elasticsearch.
Expand Down
3 changes: 3 additions & 0 deletions docs/persistence/valkey/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
tags: [persistence, explanation, valkey, redis, services]
llms:
section: Persistence
order: 170
---
# Valkey

Expand Down
6 changes: 6 additions & 0 deletions docs/services/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
llms:
section: Services and operations
order: 220
---

# Other services

This section covers the rest of the Nais functionality that didn't fit into any other categories.
Expand Down
3 changes: 3 additions & 0 deletions docs/services/secrets/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
tags: [secrets, explanation, services]
llms:
section: Services and operations
order: 230
---

# Secrets
Expand Down
3 changes: 3 additions & 0 deletions docs/tutorials/hello-nais.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
tags: [tutorial]
llms:
section: Core and getting started
order: 30
---
# :wave: Hello Nais

Expand Down
3 changes: 3 additions & 0 deletions docs/workloads/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
tags: [workloads, explanation]
llms:
section: Workloads
order: 60
---

# Workloads
Expand Down
3 changes: 3 additions & 0 deletions docs/workloads/application/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
tags: [application, explanation, workloads, services]
llms:
section: Workloads
order: 70
---

# Application
Expand Down
3 changes: 3 additions & 0 deletions docs/workloads/application/how-to/create.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
tags: [application, how-to]
llms:
section: Workloads
order: 80
---

# Create application
Expand Down
3 changes: 3 additions & 0 deletions docs/workloads/job/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
tags: [job, explanation, workloads, services]
llms:
section: Workloads
order: 90
---

# Nais job
Expand Down
Loading
Loading