Skip to content

LCORE-2933: Maintenance doc restructuring #2171

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
tisnik merged 1 commit into from
Jul 19, 2026
Merged

LCORE-2933: Maintenance doc restructuring #2171

Show file tree
Hide file tree
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
57 changes: 23 additions & 34 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ See the full documentation at [`../README.md`](../README.md) or browse sub-pages
* [User docs](#user-docs)
* [Developer doc](#developer-doc)
* [API](#api)
* [Models](#models)
* [Testing](#testing)
* [Maintenance](#maintenance)
* [Migration guides](#migration-guides)
* [Models](#models)
* [Design documents](#design-documents)
* [Agent skills](#agent-skills)
* [Automatic conversation expiration](#automatic-conversation-expiration)
Expand All @@ -24,8 +24,6 @@ See the full documentation at [`../README.md`](../README.md) or browse sub-pages
* [Llama Stack config merge (unified `lightspeed-stack.yaml`)](#llama-stack-config-merge-unified-lightspeed-stackyaml)
* [Low overhead deployment for server mode](#low-overhead-deployment-for-server-mode)
* [OpenTelemetry tracing in Lightspeed Core](#opentelemetry-tracing-in-lightspeed-core)
* [Testing](#testing)
* [Releasing](#releasing)
* [Demos](#demos)

<!-- vim-markdown-toc -->
Expand Down Expand Up @@ -54,6 +52,8 @@ See the full documentation at [`../README.md`](../README.md) or browse sub-pages

[User data collection](https://lightspeed-core.github.io/lightspeed-stack/user_doc/user_data_collection.html)

[Sentry error tracking](https://lightspeed-core.github.io/lightspeed-stack/sentry.html)

## Developer doc

[Architecture](https://lightspeed-core.github.io/lightspeed-stack/devel_doc/ARCHITECTURE.html)
Expand All @@ -78,38 +78,43 @@ See the full documentation at [`../README.md`](../README.md) or browse sub-pages

[Conversations API](https://lightspeed-core.github.io/lightspeed-stack/devel_doc/conversations_api.html)

### Models

## Maintenance
[Common](https://lightspeed-core.github.io/lightspeed-stack/models/common.html)

[Status of Lightspeed Core Stack versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/version_status.html)
[Database](https://lightspeed-core.github.io/lightspeed-stack/models/database.html)

[Supported versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/versions_supported.html)
[Requests](https://lightspeed-core.github.io/lightspeed-stack/models/requests.html)

[Unsupported versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/versions_unsupported.html)
[Successful responses](https://lightspeed-core.github.io/lightspeed-stack/models/responses_succ.html)

## Migration guides
[Error responses](https://lightspeed-core.github.io/lightspeed-stack/models/responses_errors.html)

[Migration guides](https://lightspeed-core.github.io/lightspeed-stack/migrations/)
[Compaction](https://lightspeed-core.github.io/lightspeed-stack/models/compaction.html)

### Testing

[Sentry error tracking](https://lightspeed-core.github.io/lightspeed-stack/sentry.html)
[Testing](https://lightspeed-core.github.io/lightspeed-stack/testing.html)

[End-to-End Tests Guide](https://lightspeed-core.github.io/lightspeed-stack/e2e_testing.html)

[List of e2e scenarios](https://lightspeed-core.github.io/lightspeed-stack/e2e_scenarios.html)

## Models
## Maintenance

[Common](https://lightspeed-core.github.io/lightspeed-stack/models/common.html)
[Status of Lightspeed Core Stack versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/version_status.html)

[Database](https://lightspeed-core.github.io/lightspeed-stack/models/database.html)
[Supported versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/versions_supported.html)

[Requests](https://lightspeed-core.github.io/lightspeed-stack/models/requests.html)
[Unsupported versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/versions_unsupported.html)

[Successful responses](https://lightspeed-core.github.io/lightspeed-stack/models/responses_succ.html)
[Migration guides](https://lightspeed-core.github.io/lightspeed-stack/migrations/)

[Error responses](https://lightspeed-core.github.io/lightspeed-stack/models/responses_errors.html)
[Branching](https://lightspeed-core.github.io/lightspeed-stack/maintenance/branching.html)

[Compaction](https://lightspeed-core.github.io/lightspeed-stack/models/compaction.html)
[Releasing](https://lightspeed-core.github.io/lightspeed-stack/maintenance/releasing.html)

[LTS process overview](https://lightspeed-core.github.io/lightspeed-stack/maintenance/lts_flow.html)

## Design documents

Expand Down Expand Up @@ -161,22 +166,6 @@ See the full documentation at [`../README.md`](../README.md) or browse sub-pages

[Design](https://lightspeed-core.github.io/lightspeed-stack/design/observability-opentelemetry/observability-opentelemetry.html)

## Testing

[Testing](https://lightspeed-core.github.io/lightspeed-stack/testing.html)

[End-to-End Tests Guide](https://lightspeed-core.github.io/lightspeed-stack/e2e_testing.html)

[List of e2e scenarios](https://lightspeed-core.github.io/lightspeed-stack/e2e_scenarios.html)

## Releasing

[Branching](https://lightspeed-core.github.io/lightspeed-stack/branching.html)

[Releasing](https://lightspeed-core.github.io/lightspeed-stack/releasing.html)

[LTS provess overview](https://lightspeed-core.github.io/lightspeed-stack/lts_flow.html)

## Demos

[LCORE introduction](https://lightspeed-core.github.io/lightspeed-stack/demos/lcore/lcore.html#/)
Expand Down
57 changes: 23 additions & 34 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ product questions using backend LLM services, agents, and RAG databases.
* [User docs](#user-docs)
* [Developer doc](#developer-doc)
* [API](#api)
* [Models](#models)
* [Testing](#testing)
* [Maintenance](#maintenance)
* [Migration guides](#migration-guides)
* [Models](#models)
* [Design documents](#design-documents)
* [Agent skills](#agent-skills)
* [Automatic conversation expiration](#automatic-conversation-expiration)
Expand All @@ -31,8 +31,6 @@ product questions using backend LLM services, agents, and RAG databases.
* [Llama Stack config merge (unified `lightspeed-stack.yaml`)](#llama-stack-config-merge-unified-lightspeed-stackyaml)
* [Low overhead deployment for server mode](#low-overhead-deployment-for-server-mode)
* [OpenTelemetry tracing in Lightspeed Core](#opentelemetry-tracing-in-lightspeed-core)
* [Testing](#testing)
* [Releasing](#releasing)
* [Demos](#demos)

<!-- vim-markdown-toc -->
Expand Down Expand Up @@ -61,6 +59,8 @@ product questions using backend LLM services, agents, and RAG databases.

[User data collection](https://lightspeed-core.github.io/lightspeed-stack/user_doc/user_data_collection.html)

[Sentry error tracking](https://lightspeed-core.github.io/lightspeed-stack/sentry.html)

## Developer doc

[Architecture](https://lightspeed-core.github.io/lightspeed-stack/devel_doc/ARCHITECTURE.html)
Expand All @@ -85,38 +85,43 @@ product questions using backend LLM services, agents, and RAG databases.

[Conversations API](https://lightspeed-core.github.io/lightspeed-stack/devel_doc/conversations_api.html)

### Models

## Maintenance
[Common](https://lightspeed-core.github.io/lightspeed-stack/models/common.html)

[Status of Lightspeed Core Stack versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/version_status.html)
[Database](https://lightspeed-core.github.io/lightspeed-stack/models/database.html)

[Supported versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/versions_supported.html)
[Requests](https://lightspeed-core.github.io/lightspeed-stack/models/requests.html)

[Unsupported versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/versions_unsupported.html)
[Successful responses](https://lightspeed-core.github.io/lightspeed-stack/models/responses_succ.html)

## Migration guides
[Error responses](https://lightspeed-core.github.io/lightspeed-stack/models/responses_errors.html)

[Migration guides](https://lightspeed-core.github.io/lightspeed-stack/migrations/)
[Compaction](https://lightspeed-core.github.io/lightspeed-stack/models/compaction.html)

### Testing

[Sentry error tracking](https://lightspeed-core.github.io/lightspeed-stack/sentry.html)
[Testing](https://lightspeed-core.github.io/lightspeed-stack/testing.html)

[End-to-End Tests Guide](https://lightspeed-core.github.io/lightspeed-stack/e2e_testing.html)

[List of e2e scenarios](https://lightspeed-core.github.io/lightspeed-stack/e2e_scenarios.html)

## Models
## Maintenance

[Common](https://lightspeed-core.github.io/lightspeed-stack/models/common.html)
[Status of Lightspeed Core Stack versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/version_status.html)

[Database](https://lightspeed-core.github.io/lightspeed-stack/models/database.html)
[Supported versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/versions_supported.html)

[Requests](https://lightspeed-core.github.io/lightspeed-stack/models/requests.html)
[Unsupported versions](https://lightspeed-core.github.io/lightspeed-stack/maintenance/versions_unsupported.html)

[Successful responses](https://lightspeed-core.github.io/lightspeed-stack/models/responses_succ.html)
[Migration guides](https://lightspeed-core.github.io/lightspeed-stack/migrations/)

[Error responses](https://lightspeed-core.github.io/lightspeed-stack/models/responses_errors.html)
[Branching](https://lightspeed-core.github.io/lightspeed-stack/maintenance/branching.html)

[Compaction](https://lightspeed-core.github.io/lightspeed-stack/models/compaction.html)
[Releasing](https://lightspeed-core.github.io/lightspeed-stack/maintenance/releasing.html)

[LTS process overview](https://lightspeed-core.github.io/lightspeed-stack/maintenance/lts_flow.html)

## Design documents

Expand Down Expand Up @@ -168,22 +173,6 @@ product questions using backend LLM services, agents, and RAG databases.

[Design](https://lightspeed-core.github.io/lightspeed-stack/design/observability-opentelemetry/observability-opentelemetry.html)

## Testing

[Testing](https://lightspeed-core.github.io/lightspeed-stack/testing.html)

[End-to-End Tests Guide](https://lightspeed-core.github.io/lightspeed-stack/e2e_testing.html)

[List of e2e scenarios](https://lightspeed-core.github.io/lightspeed-stack/e2e_scenarios.html)

## Releasing

[Branching](https://lightspeed-core.github.io/lightspeed-stack/branching.html)

[Releasing](https://lightspeed-core.github.io/lightspeed-stack/releasing.html)

[LTS provess overview](https://lightspeed-core.github.io/lightspeed-stack/lts_flow.html)

## Demos

[LCORE introduction](https://lightspeed-core.github.io/lightspeed-stack/demos/lcore/lcore.html#/)
Expand Down
6 changes: 3 additions & 3 deletions docs/branching.md → docs/maintenance/branching.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,15 +157,15 @@ branch naming conventions are not covered here.

### Feature and fix branches that are merged into the main branch

[branching_1](https://lightspeed-core.github.io/lightspeed-stack/branching_1.svg)
[branching_1](https://lightspeed-core.github.io/lightspeed-stack/maintenance/branching_1.svg)

### Cherry-picking changes into release (stable) branch from the main branch

[branching_2](https://lightspeed-core.github.io/lightspeed-stack/branching_2.svg)
[branching_2](https://lightspeed-core.github.io/lightspeed-stack/maintenance/branching_2.svg)

### Multiple release branches, fixes made in fix branches

[branching_3](https://lightspeed-core.github.io/lightspeed-stack/branching_3.svg)
[branching_3](https://lightspeed-core.github.io/lightspeed-stack/maintenance/branching_3.svg)


## Branching strategy
Expand Down
0 docs/branching_1.svg → docs/maintenance/branching_1.svg
View file
Open in desktop
File renamed without changes
0 docs/branching_2.svg → docs/maintenance/branching_2.svg
View file
Open in desktop
File renamed without changes
0 docs/branching_3.svg → docs/maintenance/branching_3.svg
View file
Open in desktop
File renamed without changes
0 docs/lts_flow.md → docs/maintenance/lts_flow.md
View file
Open in desktop
File renamed without changes.
0 docs/lts_flow.svg → docs/maintenance/lts_flow.svg
View file
Open in desktop
File renamed without changes
0 docs/releasing.md → docs/maintenance/releasing.md
View file
Open in desktop
File renamed without changes.
0 docs/both_services_in_container.svg → docs/user_doc/both_services_in_container.svg
View file
Open in desktop
File renamed without changes
0 docs/lcs_in_container.svg → docs/user_doc/lcs_in_container.svg
View file
Open in desktop
File renamed without changes
0 docs/llama_stack_as_library.svg → docs/user_doc/llama_stack_as_library.svg
View file
Open in desktop
File renamed without changes
0 docs/llama_stack_as_service.svg → docs/user_doc/llama_stack_as_service.svg
View file
Open in desktop
File renamed without changes
0 docs/rest_api.png → docs/user_doc/rest_api.png
View file
Open in desktop
File renamed without changes
0 docs/rest_api.svg → docs/user_doc/rest_api.svg
View file
Open in desktop
File renamed without changes
0 docs/rest_api.uml → docs/user_doc/rest_api.uml
View file
Open in desktop
File renamed without changes.
Loading