diff --git a/docs/README.md b/docs/README.md index e37225ed6..9c423fdb5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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) @@ -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) @@ -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) @@ -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 @@ -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#/) diff --git a/docs/index.md b/docs/index.md index e92ba0164..f4413ddf5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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) @@ -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) @@ -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) @@ -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 @@ -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#/) diff --git a/docs/branching.md b/docs/maintenance/branching.md similarity index 99% rename from docs/branching.md rename to docs/maintenance/branching.md index 2a04ab8e8..64db13f1c 100644 --- a/docs/branching.md +++ b/docs/maintenance/branching.md @@ -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 diff --git a/docs/branching_1.svg b/docs/maintenance/branching_1.svg similarity index 100% rename from docs/branching_1.svg rename to docs/maintenance/branching_1.svg diff --git a/docs/branching_2.svg b/docs/maintenance/branching_2.svg similarity index 100% rename from docs/branching_2.svg rename to docs/maintenance/branching_2.svg diff --git a/docs/branching_3.svg b/docs/maintenance/branching_3.svg similarity index 100% rename from docs/branching_3.svg rename to docs/maintenance/branching_3.svg diff --git a/docs/lts_flow.md b/docs/maintenance/lts_flow.md similarity index 100% rename from docs/lts_flow.md rename to docs/maintenance/lts_flow.md diff --git a/docs/lts_flow.svg b/docs/maintenance/lts_flow.svg similarity index 100% rename from docs/lts_flow.svg rename to docs/maintenance/lts_flow.svg diff --git a/docs/releasing.md b/docs/maintenance/releasing.md similarity index 100% rename from docs/releasing.md rename to docs/maintenance/releasing.md diff --git a/docs/both_services_in_container.svg b/docs/user_doc/both_services_in_container.svg similarity index 100% rename from docs/both_services_in_container.svg rename to docs/user_doc/both_services_in_container.svg diff --git a/docs/lcs_in_container.svg b/docs/user_doc/lcs_in_container.svg similarity index 100% rename from docs/lcs_in_container.svg rename to docs/user_doc/lcs_in_container.svg diff --git a/docs/llama_stack_as_library.svg b/docs/user_doc/llama_stack_as_library.svg similarity index 100% rename from docs/llama_stack_as_library.svg rename to docs/user_doc/llama_stack_as_library.svg diff --git a/docs/llama_stack_as_service.svg b/docs/user_doc/llama_stack_as_service.svg similarity index 100% rename from docs/llama_stack_as_service.svg rename to docs/user_doc/llama_stack_as_service.svg diff --git a/docs/rest_api.png b/docs/user_doc/rest_api.png similarity index 100% rename from docs/rest_api.png rename to docs/user_doc/rest_api.png diff --git a/docs/rest_api.svg b/docs/user_doc/rest_api.svg similarity index 100% rename from docs/rest_api.svg rename to docs/user_doc/rest_api.svg diff --git a/docs/rest_api.uml b/docs/user_doc/rest_api.uml similarity index 100% rename from docs/rest_api.uml rename to docs/user_doc/rest_api.uml