Skip to content

LCORE-581: doc about the script #448

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 26, 2025
Merged

LCORE-581: doc about the script #448

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,18 @@ The service includes comprehensive user data collection capabilities for various
* [K8s based authentication](#k8s-based-authentication)
* [JSON Web Keyset based authentication](#json-web-keyset-based-authentication)
* [No-op authentication](#no-op-authentication)
* [CORS](#cors)
* [Default values](#default-values)
* [Allow credentials](#allow-credentials)
* [RAG Configuration](#rag-configuration)
* [Example configurations for inference](#example-configurations-for-inference)
* [Usage](#usage)
* [Make targets](#make-targets)
* [Running Linux container image](#running-linux-container-image)
* [Building Container Images](#building-container-images)
* [Llama-Stack as Separate Service (Server Mode)](#llama-stack-as-separate-service-server-mode)
* [Llama-Stack as Library (Library Mode)](#llama-stack-as-library-library-mode)
* [Verify it's running properly](#verify-its-running-properly)
* [Endpoints](#endpoints)
* [OpenAPI specification](#openapi-specification)
* [Readiness Endpoint](#readiness-endpoint)
Expand All @@ -54,6 +62,9 @@ The service includes comprehensive user data collection capabilities for various
* [Utility to generate OpenAPI schema](#utility-to-generate-openapi-schema)
* [Path](#path)
* [Usage](#usage-1)
* [Utility to generate documentation from source codes](#utility-to-generate-documentation-from-source-codes)
* [Path](#path-1)
* [Usage](#usage-2)
* [Data Export Integration](#data-export-integration)
* [Quick Integration](#quick-integration)
* [Documentation](#documentation)
Expand Down Expand Up @@ -733,6 +744,20 @@ This script re-generated OpenAPI schema for the Lightspeed Service REST API.
make schema
```

## Utility to generate documentation from source code

This script re-generate README.md files for all modules defined in the Lightspeed Stack Service.

### Path

[scripts/gen_doc.py](scripts/gen_doc.py)

### Usage

```
make doc
```

# Data Export Integration

The Lightspeed Core Stack integrates with the [lightspeed-to-dataverse-exporter](https://github.com/lightspeed-core/lightspeed-to-dataverse-exporter) service to automatically export various types of user interaction data to Red Hat's Dataverse for analysis.
Expand Down